summaryrefslogtreecommitdiff
path: root/doc/contributing
AgeCommit message (Collapse)Author
2024-08-23Adds remarks about returned EnumeratorBurdetteLamar
2024-08-08[DOC] Add remark about in-brief for method docBurdetteLamar
Notes: Merged: https://github.com/ruby/ruby/pull/11330
2024-07-31[DOC] Adds "Further Considerations" to documentation_guide.md (#11281)Burdette Lamar
Notes: Merged-By: peterzhu2118 <peter@peterzhu.ca>
2024-07-29Add remark about call-seqBurdetteLamar
Notes: Merged: https://github.com/ruby/ruby/pull/11261
2024-07-07[DOC] Fix typo `with` -> `wish`cdfzo
2024-06-02[DOC] building_ruby: Move the caution to a footnoteNobuyoshi Nakada
2024-06-02[DOC] building_ruby: External library linksNobuyoshi Nakada
- `OpenSSL` here is not the class. - libexecinfo on FreeBSD is present in the base system of all supported releases, since 2017.
2024-06-02[DOC] building_ruby: Refine linksNobuyoshi Nakada
Get rid of using ambiguous demonstratives as link anchors, for the accessibility's sake.
2024-06-02[DOC] building_ruby: Fold long linesNobuyoshi Nakada
2024-06-02[DOC] Caution about old GNU makeNobuyoshi Nakada
2024-05-10Update ASAN docs to refer to Clang 18's releaseKJ Tsanaktsidis
Clang 18 has the bugfix we need, so we no longer need to tell people to compile Clang from source.
2024-04-24Removed obsoleted section because make docs is removed from default make taskHiroshi SHIBATA
2024-04-17Update build and install document related ↵Hiroshi SHIBATA
https://blade.ruby-lang.org/ruby-dev/39325
2024-03-31Document how to run the tests under ASAN now that they pass!KJ Tsanaktsidis
2024-02-26BASERUBY is now >= 3.0John Hawthorn
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-12More on auto-link (#9907)Burdette Lamar
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-12-25Typofix under doc directoryHiroshi SHIBATA
2023-12-02[DOC] More on What's Here (#9099)Burdette Lamar
* More on What's Here * More on What's Here
2023-11-23Add recommendations on link formatting in documentationBurdette Lamar
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-10-20[DOC] Improve docs for how to generate documentationMatheus Richard
It might not be obvious how to get the build directory and the Makefile set up.
2023-10-14[DOC] testing_ruby.md: Add spec/ for the explanation of the `make check`.Jun Aruga
2023-10-14[DOC] testing_ruby.md: Remove the command prompt '$ ` aligning with other parts.Jun Aruga
Remove the command prompt '$ ` aligning with other parts in the document.
2023-10-09testing_ruby.md: Document running test suites on s390x CPU architecture [ci ↵Jun Aruga
skip] (#8589)
2023-09-24[DOC] Correction for doc guide + TOC fix in File (#8505)Burdette Lamar
2023-08-26Add documentation regarding how to build Ruby for debugging. (#8290)Samuel Williams
Co-authored-by: Nobuyoshi Nakada <nobu@ruby-lang.org> Notes: Merged-By: ioquatix <samuel@codeotaku.com>
2023-08-23[DOC] Adding font usage to doc guide (#8255)Burdette Lamar
Notes: Merged-By: peterzhu2118 <peter@peterzhu.ca>
2023-08-12[DOC] Update to use `SPECOPTS` instead of `MSPECOPT`Nobuyoshi Nakada
Notes: Merged: https://github.com/ruby/ruby/pull/8210
2023-08-11[DOC] Don't suppress autolinks (#8207)Burdette Lamar
Notes: Merged-By: peterzhu2118 <peter@peterzhu.ca>
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-28[DOC] Fixes for link fragments (#7981)Burdette Lamar
Notes: Merged-By: peterzhu2118 <peter@peterzhu.ca>
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-26testing_ruby.md: Update `make test-all` tips [ci skip]Jun Aruga
Notes: Merged: https://github.com/ruby/ruby/pull/7861
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 <nobu@ruby-lang.org> Notes: Merged: https://github.com/ruby/ruby/pull/7798 Merged-By: yui-knk <spiketeika@gmail.com>
2023-05-10readline or libedit is no longer required to build rubyHiroshi SHIBATA
2023-05-09Fix broken link to maintainers pageJemma Issroff
Notes: Merged: https://github.com/ruby/ruby/pull/7792
2023-04-05Add BIN as an entry in the glossary (#7667)Adam Hess
I initially thought this macro is referencing binary, not basic instruction name Notes: Merged-By: k0kubun <takashikkbn@gmail.com>
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 <takashikkbn@gmail.com>
2023-03-03[DOC] Add missing word to documentation_guide.mdEzra-Shimon Rosenfeld
Notes: Merged: https://github.com/ruby/ruby/pull/7414
2023-02-19Mention when it is appropriate to document aliases in call-seqJeremy Evans
2023-02-19[DOC] Change to handling of aliases (#7340)Burdette Lamar
Change to handling of aliases Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2023-02-09Add internals glossaryAaron Patterson
I started a glossary to help new contributors navigate the internals of CRuby, and I think we should maintain it in ruby/ruby Notes: Merged: https://github.com/ruby/ruby/pull/7280
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
generated by cgit v1.2.3 (git 2.25.1) at 2026-01-19 12:01:21 +0000