summaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2024-11-25Escape Module in the headerStan Lo
Notes: Merged: https://github.com/ruby/ruby/pull/12157
2024-11-25Add new lines after headersStan Lo
Notes: Merged: https://github.com/ruby/ruby/pull/12157
2024-11-25Update RDoc's maintainers listStan Lo
Notes: Merged: https://github.com/ruby/ruby/pull/12157
2024-11-20[ruby/date] [DOC] Make document coverage 100%Nobuyoshi Nakada
https://github.com/ruby/date/commit/269392b775
2024-11-19[DOC] Fix the default `limit` of String#splitKouhei Yanagita
We can't pass `nil` as the second parameter of `String#split`. Therefore, descriptions like "if limit is nil, ..." are not appropriate. Notes: Merged: https://github.com/ruby/ruby/pull/12109
2024-11-12[DOC] `--with-opt-dir` options and `CONFIGURE_ARGS`Nobuyoshi Nakada
Notes: Merged: https://github.com/ruby/ruby/pull/12059
2024-10-29[ruby/strscan] [DOC] doc/strscan/strscan.md - fix triple backtickMSP-Greg
(https://github.com/ruby/strscan/pull/112) See current doc, search for '## Target Substring', notice the backtick that isn't visible to the GitHub md parser. https://github.com/ruby/strscan/blob/843e931d134b0a8f0284296250454374e3f8a6aa/doc/strscan/strscan.md Fixed in the PR, see: https://github.com/MSP-Greg/strscan/blob/00-strscan.md/doc/strscan/strscan.md https://github.com/ruby/strscan/commit/041b15df4c
2024-10-28[DOC] Tweaks for windows.mdNobuyoshi Nakada
2024-10-28Win32: [DOC] Update about program name configurationsNobuyoshi Nakada
2024-10-28Win32: [DOC] Mention `vcvarall*.bat`Nobuyoshi Nakada
2024-10-28Win32: [DOC] No extlibs file, no patch is neededNobuyoshi Nakada
2024-10-17YJIT: Add compilation log (#11818)Kevin Menard
* YJIT: Add `--yjit-compilation-log` flag to print out the compilation log at exit. * YJIT: Add an option to enable the compilation log at runtime. * YJIT: Fix a typo in the `IseqPayload` docs. * YJIT: Add stubs for getting the YJIT compilation log in memory. * YJIT: Add a compilation log based on a circular buffer to cap the log size. * YJIT: Allow specifying either a file or directory name for the YJIT compilation log. The compilation log will be populated as compilation events occur. If a directory is supplied, then a filename based on the PID will be used as the write target. If a file name is supplied instead, the log will be written to that file. * YJIT: Add JIT compilation of C function substitutions to the compilation log. * YJIT: Add compilation events to the circular buffer even if output is sent to a file. Previously, the two modes were treated as being exclusive of one another. However, it could be beneficial to log all events to a file while also allowing for direct access of the last N events via `RubyVM::YJIT.compilation_log`. * YJIT: Make timestamps the first element in the YJIT compilation log tuple. * YJIT: Stream log to stderr if `--yjit-compilation-log` is supplied without an argument. * YJIT: Eagerly compute compilation log messages to avoid hanging on to references that may GC. * YJIT: Log all compiled blocks, not just the method entry points. * YJIT: Remove all compilation events other than block compilation to slim down the log. * YJIT: Replace circular buffer iterator with a consuming loop. * YJIT: Support `--yjit-compilation-log=quiet` as a way to activate the in-memory log without printing it. Co-authored-by: Randy Stauner <[email protected]> * YJIT: Promote the compilation log to being the one YJIT log. Co-authored-by: Randy Stauner <[email protected]> * Update doc/yjit/yjit.md * Update doc/yjit/yjit.md --------- Co-authored-by: Randy Stauner <[email protected]> Co-authored-by: Maxime Chevalier-Boisvert <[email protected]> Notes: Merged-By: maximecb <[email protected]>
2024-10-17Update maintainers of PrismKevin Newton
Notes: Merged: https://github.com/ruby/ruby/pull/11909
2024-10-11Fix spellingJohn Bampton
Notes: Merged: https://github.com/ruby/ruby/pull/11882 Merged-By: XrXr
2024-10-11YJIT: Improve build instructions for non-hackers (#11878)Alan Wu
Notes: Merged-By: maximecb <[email protected]>
2024-10-11[DOC] Tweak "Timezone Objects"Nobuyoshi Nakada
- Make method descriptions plain pragraphs in each method. - Make "Argument" and "Returns" note-lists. Notes: Merged: https://github.com/ruby/ruby/pull/11869
2024-10-09Added byroot to JSON maintainerHiroshi SHIBATA
[Misc #20746]
2024-10-07Update references to flori/jsonJean Boussier
Now that the repository was transfered, these links will become dead in a few months. Notes: Merged: https://github.com/ruby/ruby/pull/11820
2024-10-07YJIT: Add --yjit-mem-size option (#11810)Takashi Kokubun
* YJIT: Add --yjit-mem-size option * Improve --help * s/the region/this virtual memory region/ Co-authored-by: Maxime Chevalier-Boisvert <[email protected]> --------- Co-authored-by: Maxime Chevalier-Boisvert <[email protected]> Notes: Merged-By: maximecb <[email protected]>
2024-10-02[DOC] Fix typo in Forwardable docsNithin Bekal
Notes: Merged: https://github.com/ruby/ruby/pull/11759
2024-09-29[DOC] Refine about offset directivesNobuyoshi Nakada
Notes: Merged: https://github.com/ruby/ruby/pull/11721
2024-09-25doc: Remove description of experimental warnings related pattern matching ↵masatoshi_moritsuka
from documentation Ruby 3.2.0 has been released and all experimental warnings about pattern matching have been removed. Experimental warnings about pattern matching are no longer output, so I remove description about it from documentation as well. cf. https://bugs.ruby-lang.org/issues/18585 cf. db6b23c76cbc7888cd9a9912790c2068703afdd0 cf. https://twitter.com/k_tsj/status/1606956336037900289?s=20&t=-_PSYLhYPtYsB9FZhtXl5A Notes: Merged: https://github.com/ruby/ruby/pull/7052
2024-09-10[DOC] Fix linkBurdetteLamar
Notes: Merged: https://github.com/ruby/ruby/pull/11528
2024-09-02[ruby/rdoc] [DOC] Fix links (https://github.com/ruby/rdoc/pull/1169)Burdette Lamar
https://github.com/ruby/rdoc/commit/a576ff890f
2024-08-23Adds remarks about returned EnumeratorBurdetteLamar
2024-08-21[DOC] Include keywords.rdoc in doc/syntax/ (#11414)Burdette Lamar
Notes: Merged-By: peterzhu2118 <[email protected]>
2024-08-17[DOC] Add `$;` to the list of deprecated global variablesNeil Carvalho
Notes: Merged: https://github.com/ruby/ruby/pull/11392 Merged-By: nobu <[email protected]>
2024-08-08YJIT: Allow tracing fallback counters (#11347)Takashi Kokubun
* YJIT: Allow tracing fallback counters * Update yjit.md about --yjit-trace-exits=counter Notes: Merged-By: k0kubun <[email protected]>
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-29[ruby/rdoc] [DOC] Mods about markup formatsBurdette Lamar
(https://github.com/ruby/rdoc/pull/1143) https://github.com/ruby/rdoc/commit/011de3f2fd
2024-07-29Add remark about call-seqBurdetteLamar
Notes: Merged: https://github.com/ruby/ruby/pull/11261
2024-07-16Add MatchData#bytebegin and MatchData#byteendShugo Maeda
These methods return the byte-based offset of the beginning or end of the specified match. [Feature #20576]
2024-07-11YJIT: remove doc/yjit/yjit_hacking.md (#11153)Maxime Chevalier-Boisvert
Document is 3 years old and out of date
2024-07-11Update yjit.md, explain how to run a single test with test-all (#11151)Maxime Chevalier-Boisvert
2024-07-07[DOC] Fix typo `with` -> `wish`cdfzo
2024-07-05[DOC] yjit.md: Markdown fixes for RDocAlan Wu
It now renders properly on both GitHub and with RDoc's darkfish theme.
2024-07-01[ruby/irb] fix typos in the `Index of Command-Line Options`Anatoly Busygin
https://github.com/ruby/irb/commit/3512020f1c
2024-06-26[DOC] Doc for exceptions (#11008)Burdette Lamar
2024-06-26Mentioned new mswin tasks related with vcpkgHiroshi SHIBATA
2024-06-26Added git for requirements of Windows buildHiroshi SHIBATA
2024-06-19String.new(capacity:) don't substract termlenJean Boussier
[Bug #20585] This was changed in 36a06efdd9f0604093dccbaf96d4e2cb17874dc8 because `String.new(1024)` would end up allocating `1025` bytes, but the problem with this change is that the caller may be trying to right size a String. So instead, we should just better document the behavior of `capacity:`.
2024-06-09Correct typo [ci skip]Sampat Badhe
2024-06-09[Bug #20566] Mention out-of-range argument cases in `String#<<`Nobuyoshi Nakada
Also [Bug #18973].
2024-06-07[DOC] document line continuation.Tanaka Akira
Document details of escape sequences including line continuation. [Bug #20518]
2024-06-04[DOC] Exceptions doc (#10865)Burdette Lamar
2024-06-04Removed trailing spaces.Hiroshi SHIBATA
2024-06-04Sync strscan HEAD again.Hiroshi SHIBATA
https://github.com/ruby/strscan/pull/99 split document with multi-byte chars.
2024-06-03fix typos.Tanaka Akira
2024-06-03[DOC] percent literals can be nested.Tanaka Akira
generated by cgit v1.2.3 (git 2.25.1) at 2025-06-18 19:02:57 +0000