From 7e52e3e3f7ccb0d14bd091b9ecef065eafbf2ef6 Mon Sep 17 00:00:00 2001 From: Nobuyoshi Nakada Date: Sun, 2 Jun 2024 21:07:29 +0900 Subject: [PATCH] [DOC] building_ruby: External library links - `OpenSSL` here is not the class. - libexecinfo on FreeBSD is present in the base system of all supported releases, since 2017. --- doc/contributing/building_ruby.md | 27 ++++++++++++++++++--------- 1 file changed, 18 insertions(+), 9 deletions(-) diff --git a/doc/contributing/building_ruby.md b/doc/contributing/building_ruby.md index a2f9c93807..4b54bdc774 100644 --- a/doc/contributing/building_ruby.md +++ b/doc/contributing/building_ruby.md @@ -8,14 +8,14 @@ For RubyGems, you will also need: - * OpenSSL 1.1.x or 3.0.x / LibreSSL - * libyaml 0.1.7 or later - * zlib + * [OpenSSL] 1.1.x or 3.0.x / [LibreSSL] + * [libyaml] 0.1.7 or later + * [zlib] If you want to build from the git repository, you will also need: - * autoconf - 2.67 or later - * gperf - 3.1 or later + * [autoconf] - 2.67 or later + * [gperf] - 3.1 or later * Usually unneeded; only if you edit some source files using gperf * ruby - 3.0 or later * We can upgrade this version to system ruby version of the latest @@ -23,10 +23,9 @@ 2. Install optional, recommended dependencies: - * libffi (to build fiddle) - * gmp (if you with to accelerate Bignum operations) - * libexecinfo (FreeBSD) - * rustc - 1.58.0 or later, if you wish to build + * [libffi] (to build fiddle) + * [gmp] (if you with to accelerate Bignum operations) + * [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, @@ -41,6 +40,16 @@ done ``` +[OpenSSL]: https://www.openssl.org +[LibreSSL]: https://www.libressl.org +[libyaml]: https://github.com/yaml/libyaml/ +[zlib]: https://www.zlib.net +[autoconf]: https://www.gnu.org/software/autoconf/ +[gperf]: https://www.gnu.org/software/gperf/ +[libffi]: https://sourceware.org/libffi/ +[gmp]: https://gmplib.org +[rustc]: https://www.rust-lang.org + ## Quick start guide 1. Download ruby source code: