Skip to content

Commit

Permalink
Clarify RUBY_BUILD_ROOT env var (#2392)
Browse files Browse the repository at this point in the history
* Clarify RUBY_BUILD_ROOT env var

The RUBY_BUILD_ROOT itself does not default to share/ruby-build/ but rather must point to a directory that has definitions under `share/ruby-build/`.

* Deprecate RUBY_BUILD_ROOT

It's a feature of questionable utility, it's difficult to describe in documentation, and has been superseded by RUBY_BUILD_DEFINITIONS.

---------

Co-authored-by: Mislav Marohnić <git@mislav.net>
  • Loading branch information
jasonkarns and mislav committed May 30, 2024
1 parent db6c175 commit 15bdff9
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,9 +83,9 @@ The build process may be configured through the following environment variables:
| `RUBY_BUILD_MIRROR_URL` | Custom mirror URL root. |
| `RUBY_BUILD_MIRROR_PACKAGE_URL` | Custom complete mirror URL (e.g. http://mirror.example.com/package-1.0.0.tar.gz). |
| `RUBY_BUILD_SKIP_MIRROR` | Bypass the download mirror and fetch all package files from their original URLs. |
| `RUBY_BUILD_ROOT` | Custom build definition directory. (Default: `share/ruby-build`) |
| `RUBY_BUILD_TARBALL_OVERRIDE` | Override the URL to fetch the ruby tarball from, optionally followed by `#checksum`. |
| `RUBY_BUILD_DEFINITIONS` | Additional paths to search for build definitions. (Colon-separated list) |
| `RUBY_BUILD_DEFINITIONS` | Colon-separated list of paths to search for build definition files. |
| `RUBY_BUILD_ROOT` | The path prefix to search for build definitions files. *Deprecated:* use `RUBY_BUILD_DEFINITIONS`|
| `CC` | Path to the C compiler. |
| `RUBY_CFLAGS` | Additional `CFLAGS` options (_e.g.,_ to override `-O3`). |
| `CONFIGURE_OPTS` | Additional `./configure` options. |
Expand Down

0 comments on commit 15bdff9

Please sign in to comment.