Skip to content

Commit 15bdff9

Browse files
jasonkarnsmislav
andauthored
Clarify RUBY_BUILD_ROOT env var (#2392)
* 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ć <[email protected]>
1 parent db6c175 commit 15bdff9

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,9 +83,9 @@ The build process may be configured through the following environment variables:
8383
| `RUBY_BUILD_MIRROR_URL` | Custom mirror URL root. |
8484
| `RUBY_BUILD_MIRROR_PACKAGE_URL` | Custom complete mirror URL (e.g. http://mirror.example.com/package-1.0.0.tar.gz). |
8585
| `RUBY_BUILD_SKIP_MIRROR` | Bypass the download mirror and fetch all package files from their original URLs. |
86-
| `RUBY_BUILD_ROOT` | Custom build definition directory. (Default: `share/ruby-build`) |
8786
| `RUBY_BUILD_TARBALL_OVERRIDE` | Override the URL to fetch the ruby tarball from, optionally followed by `#checksum`. |
88-
| `RUBY_BUILD_DEFINITIONS` | Additional paths to search for build definitions. (Colon-separated list) |
87+
| `RUBY_BUILD_DEFINITIONS` | Colon-separated list of paths to search for build definition files. |
88+
| `RUBY_BUILD_ROOT` | The path prefix to search for build definitions files. *Deprecated:* use `RUBY_BUILD_DEFINITIONS`|
8989
| `CC` | Path to the C compiler. |
9090
| `RUBY_CFLAGS` | Additional `CFLAGS` options (_e.g.,_ to override `-O3`). |
9191
| `CONFIGURE_OPTS` | Additional `./configure` options. |

0 commit comments

Comments
 (0)