summaryrefslogtreecommitdiff
path: root/doc/contributing
AgeCommit message (Collapse)Author
10 daysMore comprehensive debugging configurationÉtienne Barrié
2025-04-18Mention VS Code debugger configuration in debugging guideStan Lo
Notes: Merged: https://github.com/ruby/ruby/pull/13129
2025-03-31[DOC] Tweaks for docs about contributing (#13012)Burdette Lamar
Notes: Merged-By: peterzhu2118 <[email protected]>
2025-01-31- Add a mention to git 2.32 in the building ruby documentation:Edouard CHIN
I had issues building Ruby as I was using git 2.30. The error was: > file2lastrev.rb: git rev-parse failed error: could not expand > include path '~/.gitcinclude' The default system git config includes paths making use of `$HOME`, but that env variable gets removed when building: https://github.com/ruby/ruby/blob/7070b1b1968f31f999636b42a1af872458cd5a81/tool/lib/vcs.rb#L546-L547 It works with git `>= 2.32` thanks to the `GIT_CONFIG_SYSTEM` feature which gets set to a Null IO in order to override the system gitconfig. https://github.com/ruby/ruby/blob/7070b1b1968f31f999636b42a1af872458cd5a81/tool/lib/vcs.rb#L549 Notes: Merged: https://github.com/ruby/ruby/pull/12611
2025-01-16[DOC] Link to MarkupReference directlyNobuyoshi Nakada
Notes: Merged: https://github.com/ruby/ruby/pull/12586
2025-01-02[DOC] Exclude 'Class' and 'Module' from RDoc's autolinkingNobuyoshi Nakada
Notes: Merged: https://github.com/ruby/ruby/pull/12496
2024-12-12Improve "Building Ruby" docs (#12320)Alexander Momchilov
* Clarify “Building Ruby” docs * Fix test examples to work from `build` dir * Clarify “Testing Ruby” examples with real examples All the commands should run correctly by default, without the user needing to modify them. This builds confidence that the relative paths are working correct from within the `build` directory. Also, let’s use a consistent example throughout, for greater clarity. * Improve examples to use `-v` flag in-context This shows the correct way to combine `-v` with another parameter, e.g. a specific file to test. * Other readability improvements * Clarify `make` implementation support
2024-12-12[DOC] Improve formatting in Markdown files (#12322)Alexander Momchilov
* Fix WASM bullet/code indentation * Use `console` code highlighting where appropriate … which handles the prefix `$` correctly. * Migrate feature proposal template to MarkDown * Set language on code blocks
2024-11-12[DOC] `--with-opt-dir` options and `CONFIGURE_ARGS`Nobuyoshi Nakada
Notes: Merged: https://github.com/ruby/ruby/pull/12059
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 <[email protected]>
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 <[email protected]> Notes: Merged-By: ioquatix <[email protected]>
2023-08-23[DOC] Adding font usage to doc guide (#8255)Burdette Lamar
Notes: Merged-By: peterzhu2118 <[email protected]>
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 <[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-28[DOC] Fixes for link fragments (#7981)Burdette Lamar
Notes: Merged-By: peterzhu2118 <[email protected]>
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 <[email protected]> Notes: Merged: https://github.com/ruby/ruby/pull/7798 Merged-By: yui-knk <[email protected]>