summaryrefslogtreecommitdiff
path: root/doc/contributing/building_ruby.md
AgeCommit message (Collapse)Author
2024-02-15s/bellow/below/ydah
2024-02-13Fix typo in asan section of building_ruby.md docsKJ Tsanaktsidis
s/copmiler-rt/compiler-rt/
2024-02-12Update ASAN docs to reflect the current state of thingsKJ Tsanaktsidis
I don't really think ASAN works well at all on any version of Ruby from before https://bugs.ruby-lang.org/issues/20001 was landed. Update the docs to clarify what works, and what does not work. Also there's no need to compile at `-O0`; this was probably just hiding some of the problems with our stack scanning that were fixed in the above issue. [Bug #20248]
2024-01-18[DOC] Update ruby version in Building Ruby DependenciesKazuhiro NISHIYAMA
2023-11-06[DOC] Use a relative link like other linksTakashi Kokubun
following up on https://github.com/ruby/ruby/pull/8832
2023-11-06Updated building_ruby.md to include reference for building on WindowsJorandeBoer
Looking at building_ruby.md it is unclear that you are able to build Ruby on Windows. To fix that a reference has been added to the windows.md file.
2023-10-20[DOC] `configure -C` tipsNobuyoshi Nakada
2023-08-26Add documentation regarding how to build Ruby for debugging. (#8290)Samuel Williams
Co-authored-by: Nobuyoshi Nakada <[email protected]> Notes: Merged-By: ioquatix <[email protected]>
2023-07-14[Doc] Make build instructions easier to copy-and-pastejinroq
Notes: Merged: https://github.com/ruby/ruby/pull/8077 Merged-By: XrXr
2023-06-26[DOC] Nested ordered lists need more indentsNobuyoshi Nakada
2023-06-25Fix broken linksBurdetteLamar
Notes: Merged: https://github.com/ruby/ruby/pull/7979
2023-05-12Use Lrama LALR parser generator instead of Bisonv3_3_0_preview1Yuichiro Kaneko
https://bugs.ruby-lang.org/issues/19637 Co-authored-by: Nobuyoshi Nakada <[email protected]> Notes: Merged: https://github.com/ruby/ruby/pull/7798 Merged-By: yui-knk <[email protected]>
2023-05-10readline or libedit is no longer required to build rubyHiroshi SHIBATA
2023-03-10Bump the required BASERUBY version to 2.5 (#7504)Takashi Kokubun
[Misc #16671] I'd like to bump it to 2.7 to use pattern matching in tool/mk_builtin_loader.rb. However, I experienced a few blockers. 2.5 seems like the closest version that is easy enough to use on CIs, so let me bump the version to it as an intermediate step for it. I want to use &. and <<~ in 2.3 too. Known blockers: * AppVeyor Visual Studio 2015 doesn't have Ruby 2.7. You'd need to bump the version to Visual Studio 2019. * GitHub Actions windows-2019 doesn't have Ruby 2.7 either. You can use ruby/setup-ruby, but configure doesn't seem to work with it. * For ruby/ruby-ci-imaage, bionic doesn't have Ruby 2.7. I tried using ruby-build to build Ruby 2.7 from package, but the build on its CI seems to somehow loop forever when I do that. So I gave it up for now. We might want to wait until bionic becomes EOL. Note: * AppVeyor Visual Studio 2015 has Ruby <= 2.6.3 https://www.appveyor.com/docs/windows-images-software/#ruby * GitHub Actions windows-2019 uses Ruby 2.5.9 https://github.com/actions/runner-images/blob/main/images/win/Windows2019-Readme.md Notes: Merged-By: k0kubun <[email protected]>
2023-02-08[DOC] Refine/fix doc/contributing/building_ruby.md [ci skip]Nobuyoshi Nakada
* Separate dependencies for RubyGems * Add reasons of optional libraries * Add a note for gperf and fix the required version
2023-02-07Fix confusing "Benoit Daloze
2023-02-07Mentioned gmp at requirementsHiroshi SHIBATA
2023-02-07Added tarball instruction to building_ruby.mdHiroshi SHIBATA
2023-01-20OpenSSL, libyaml and zlib is always required to build. see test/test_extlibs.rbHiroshi SHIBATA
2023-01-20Added supported versions to OpenSSL and libyamlHiroshi SHIBATA
2023-01-20Added version policy of BASERUBYHiroshi SHIBATA
[Misc #16671]
2023-01-20Separate dependencies section from quick startHiroshi SHIBATA
2023-01-20fixed wrong version of baserubyHiroshi SHIBATA
2023-01-06[DOC] Mention `configure` options earlier, not after failureNobuyoshi Nakada
The command line arguments to `configure` are stored in `rbconfig.rb`. Usually these are just useless but harmless after the installation, however could affect unexpectedly when updating default gems. Notes: Merged: https://github.com/ruby/ruby/pull/7076
2023-01-06[DOC] Specify `shell` format to shell commandsNobuyoshi Nakada
Notes: Merged: https://github.com/ruby/ruby/pull/7076
2022-11-21YJIT: Lower the required Rust version from 1.58.1 to 1.58.0 (#6780)Takashi Kokubun
Notes: Merged-By: k0kubun <[email protected]>
2022-11-10Update required Bison version in building_ruby.md [ci skip]yui-knk
See [Feature #19068] for the context. Notes: Merged: https://github.com/ruby/ruby/pull/6705
2022-11-08[doc] Clarify how to build OpenSSL on macOSMatt Valentine-House
Notes: Merged: https://github.com/ruby/ruby/pull/6692
2022-11-07[DOC] Properly number the list in building_ruby.mdPeter Zhu
2022-11-07[DOC] Improve building_ruby.mdPeter Zhu
2022-11-03Update configure command in building_ruby.mdPeter Zhu
Readers didn't realize that you can use --prefix with --disable-install-doc.
2022-10-27Update docs wrt YJIT limitations and building YJIT (#6641)Maxime Chevalier-Boisvert
* Update docs wrt YJIT limitations and building YJIT * Update building_ruby.md Fix relative link Notes: Merged-By: maximecb <[email protected]>
2022-05-30Add information from doc/hacking.md and doc/make_cheatsheet.md back i… (#5963)Jemma Issroff
Add information from doc/hacking.md and doc/make_cheatsheet.md back into contributing docs Notes: Merged-By: peterzhu2118 <[email protected]>
2022-05-18[DOC] Use `make gdb-ruby` and `make lldb-ruby` in ↵Kaíque Kandy Koga
doc/contributing/building_ruby.md Notes: Merged: https://github.com/ruby/ruby/pull/5908 Merged-By: nobu <[email protected]>
2022-05-11Improve documentation on contributing to RubyJemma Issroff
co-authored-by: Peter Zhu <[email protected]> co-authored-by: Stan Lo <[email protected]> Notes: Merged: https://github.com/ruby/ruby/pull/5899