Skip to content

Commit

Permalink
[DOC] --with-opt-dir options and CONFIGURE_ARGS
Browse files Browse the repository at this point in the history
  • Loading branch information
nobu committed Nov 12, 2024
1 parent 4c27020 commit 75fd658
Showing 1 changed file with 14 additions and 4 deletions.
18 changes: 14 additions & 4 deletions doc/contributing/building_ruby.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,20 @@
* [rustc] - 1.58.0 or later, if you wish to build
[YJIT](rdoc-ref:RubyVM::YJIT).

If you installed the libraries needed for extensions (openssl, readline,
libyaml, zlib) into other than the OS default place, typically using
Homebrew on macOS, add `--with-EXTLIB-dir` options to `CONFIGURE_ARGS`
environment variable.
If you want to link the libraries (e.g., gmp) installed into other than
the OS default place, typically using Homebrew on macOS, pass the
`--with-opt-dir` (or `--with-gmp-dir` for gmp) option to `configure`.

``` shell
configure --with-opt-dir=$(brew --prefix gmp):$(brew --prefix jemalloc)
```

As for the libraries needed for particular extensions only and not for
Ruby (openssl, readline, libyaml, zlib), you can add `--with-EXTLIB-dir`
options to the command line or to `CONFIGURE_ARGS` environment variable.
The command line options will be embedded in `rbconfig.rb`, while the
latter environment variable is not embedded and is only used when
building the extension libraries.

``` shell
export CONFIGURE_ARGS=""
Expand Down

0 comments on commit 75fd658

Please sign in to comment.