From 15bdff9b58fa57a3a990e2c2203220bd1f40265a Mon Sep 17 00:00:00 2001 From: Jason Karns Date: Thu, 30 May 2024 10:34:31 -0400 Subject: [PATCH] Clarify RUBY_BUILD_ROOT env var (#2392) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * 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ć --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 277533ccae..c325bb3876 100644 --- a/README.md +++ b/README.md @@ -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. |