summaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2025-12-15Point people to redmine on ZJIT docs (#15499)Max Bernstein
Fix https://github.com/Shopify/ruby/issues/900
2025-12-14[DOC] Remove doc/relinePeter Zhu
Reline has been moved to a bundled gem, so we don't need the docs anymore.
2025-12-11ZJIT: [DOC] Mention build prerequisitesAlan Wu
2025-12-10[ruby/stringio] [DOC] Doc for StringIO.sizeBurdette Lamar
(https://github.com/ruby/stringio/pull/171) https://github.com/ruby/stringio/commit/95a111017a
2025-12-10[ruby/stringio] [DOC] Tweaks for StringIO#each_lineBurdette Lamar
(https://github.com/ruby/stringio/pull/165) Adds to "Position": pos inside a character. Makes a couple of minor corrections. --------- https://github.com/ruby/stringio/commit/ff332abafa Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
2025-12-10[ruby/stringio] [DOC] Tweaks for StringIO#getsBurdette Lamar
(https://github.com/ruby/stringio/pull/190) https://github.com/ruby/stringio/commit/77209fac20
2025-12-10[ruby/stringio] [DOC] Tweaks for StringIO.getbyteBurdette Lamar
(https://github.com/ruby/stringio/pull/188) https://github.com/ruby/stringio/commit/66360ee5f1
2025-12-10[ruby/stringio] [DOC] Fix linkBurdetteLamar
https://github.com/ruby/stringio/commit/e2d24ae8d7
2025-12-10[ruby/stringio] [DOC] Tweaks for StringIO#getcBurdette Lamar
(https://github.com/ruby/stringio/pull/189) https://github.com/ruby/stringio/commit/e3d16d30ed
2025-12-09[DOC] Clear one of known issues of Ruby BoxNobuyoshi Nakada
2025-12-09[DOC] Update Ruby Box documents (known issues)Satoshi Tagomori
2025-12-09[DOC] Add Ruby::Box on NEWSSatoshi Tagomori
2025-12-08Update ZJIT docs (#15449)Max Bernstein
2025-12-06[DOC] Fix formatting in docs for String#[]=Peter Zhu
2025-12-06[DOC] Link global variables to command line optionsNobuyoshi Nakada
2025-12-05[ruby/stringio] [DOC] Class doc for StringIOBurdette Lamar
(https://github.com/ruby/stringio/pull/178) https://github.com/ruby/stringio/commit/6449251678
2025-12-05[DOC] Tweaks for String#capitalizeBurdetteLamar
2025-12-05[DOC] Tweaks for String#downcaseBurdetteLamar
2025-12-05[DOC] Tweaks for String#upcaseBurdetteLamar
2025-12-05[DOC] Tweaks for String#swapcaseBurdetteLamar
2025-12-05[DOC] Better multibyte-character dataBurdetteLamar
2025-12-05[DOC] Describe `$F`Nobuyoshi Nakada
This variation is used when `-a` option is given.
2025-12-05[DOC] Describe the global variables set by command line optionsNobuyoshi Nakada
These variables are set by command line options, but it is deprecated to assign them any value other than nil in ruby code.
2025-12-05[DOC] Centerize Variable, English, and Constant columnsNobuyoshi Nakada
2025-12-05fix typo s/sharable/shareable/Koichi Sasada
2025-12-04[DOC] Fix a macro nameNobuyoshi Nakada
2025-12-02[DOC] About Float Imprecision (#15293)Burdette Lamar
2025-12-02[ruby/strscan] [DOC] Avoid being interpreted as a linkYuki Kurihara
(https://github.com/ruby/strscan/pull/180) Since `[](n)` is being interpreted as a Markdown link, it cannot be displayed as a method call. I have corrected this by escaping the brackets so that they are interpreted as strings rather than links. ### Before ri ``` #{}[n] | <tt>n</tt>th captured substring. | +nil+. ``` html <img width="424" height="217" alt="image" src="https://github.com/user-attachments/assets/b45601ab-ed1c-4b82-b112-325f12bde197" /> ### After ri ``` #[](n) | <tt>n</tt>th captured substring. | +nil+. ``` html <img width="489" height="217" alt="image" src="https://github.com/user-attachments/assets/1212c147-42a5-4f62-8667-a279ccff67a3" /> https://github.com/ruby/strscan/commit/b3d56867fd
2025-12-02ZJIT: Improve documentation and make it easy to generate the types graphBenoit Daloze
2025-12-01[ruby/strscan] [DOC] Fix broken link to helper methodsBerkan Ünal
(https://github.com/ruby/strscan/pull/179) ### Helper methods link is broken at master branch To reproduce 1. go to [StringScanner docs](https://docs.ruby-lang.org/en/master/StringScanner.html) 2. Click to link at line > See examples at **helper_methods** 3. Resolved url gives 404: https://docs.ruby-lang.org/en/master/strscan/helper_methods_md.html ### Fix Currently link resolves as `href="doc/strscan/helper_methods_md.html"` Correct link should be resolved as `href="helper_methods_md.html"` https://github.com/ruby/strscan/commit/adb8678aa6
2025-12-01ZJIT: Fix erroneous version number for Iongraph (#15357)Aiden Fox Ivey
As per https://github.com/mozilla-spidermonkey/iongraph/blob/8d5e531305320216f86a24bfc9bc136a3627e832/src/iongraph.ts#L147, correct version number for the web-based tool is 1, rather than 2.
2025-11-27[DOC] Remove unneeded filename from rdoc-ref links (#15339)Stan Lo
2025-11-27Reorganize page documentations (#15154)Stan Lo
Re-organize page docs
2025-11-27Documentation: Added the `|`(pipe)/OR operator to syntax/methods.Sebastian Dufner
It was not documented as an operator that can be overriden, which is confusing because it makes you think it can't be.
2025-11-23[Misc #21688] [DOC] Include box.md in Ruby::Box documentationNobuyoshi Nakada
2025-11-23[ruby/date] [DOC] Remove the name from same file referencesNobuyoshi Nakada
https://github.com/ruby/date/commit/e41082e068
2025-11-23[DOC] Remove the name from same file referencesNobuyoshi Nakada
2025-11-20[DOC] Sort some methods in What's HereBurdetteLamar
2025-11-20[DOC] Tweaks for String#valid_encoding?Burdette Lamar
2025-11-20[DOC] Tweaks for String#uptoBurdetteLamar
2025-11-20[DOC] Tweaks for String#upcase (#15244)Burdette Lamar
2025-11-19ZJIT: Add Iongraph compatibility (#14999)Aiden Fox Ivey
## Components This PR adds functionality to visualize HIR using the [Iongraph](https://spidermonkey.dev/blog/2025/10/28/iongraph-web.html) tool first created for use with Spidermonkey. ## Justification Iongraph's viewer is (as mentioned in the article above) a few notches above graphviz for viewing large CFGs. It also allows easily inspecting different compiler optimization passes and multiple functions in the same browser window. Since Spidermonkey is using this format, it may be beneficial to use it for our own JIT development. The requirement for JSON is downstream from that of the Iongraph format. As for writing the implementation myself, ZJIT leans towards having fewer dependencies, so this is the preferred approach. ## How does it look? <img width="902" height="957" alt="image" src="https://github.com/user-attachments/assets/e4e0991b-572a-41fd-9fed-1215bd1926c3" /> <img width="770" height="624" alt="image" src="https://github.com/user-attachments/assets/01398373-1f75-46b8-b1aa-7f5d4cbca6b8" /> Right now, it's aesthetically minimal, but is fairly robust. ## Functionality Using `--zjit-dump-hir-iongraph` will dump all compiled functions into a directory named `/tmp/zjit-iongraph-{PROCESS_PID}`. Each file will be named `func_{ZJIT_FUNC_NAME}.json`. In order to use them in the Iongraph viewer, you'll need to use `jq` to collate them to a single file. An example invocation of `jq` is shown below for reference. The name of the file created does not matter to my understanding. `jq --slurp --null-input '.functions=inputs | .version=2' /tmp/zjit-iongraph-{PROCESS_PID}/func*.json > ~/Downloads/foo.json` From there, you can use https://mozilla-spidermonkey.github.io/iongraph/ to view your trace. ### Caveats - The upstream Iongraph viewer doesn't allow you to click arguments to an instruction to find the instruction that they originate from when using the format that this PR generates. (I have made a small fork at https://github.com/aidenfoxivey/iongraph that fixes that functionality via https://github.com/aidenfoxivey/iongraph/commit/9e9c29b41c4dbb35cf66cb6161e5b19c8b796379.patch) - The upstream Iongraph viewer can sometimes show "exiting edges" in the CFG as being not attached to the box representing its basic block. <img width="1814" height="762" alt="image" src="https://github.com/user-attachments/assets/afbbaa16-332f-498f-849e-11c69a8cb0cc" /> (Image courtesy of @tekknolagi) This is because the original tool was (to our understanding) written for an SSA format that does not use extended basic blocks. (Extended basic blocks let you put a jump instruction, conditional or otherwise, anywhere in the basic block.) This means that our format may generate more outgoing edges than the viewer is written to handle.
2025-11-19[DOC] Update yjit.md to use a different emailStan Lo
2025-11-18[DOC] Tweaks for String#unicode_normalizeBurdetteLamar
2025-11-18[DOC] Tweaks for String#dump and String#undumpBurdette Lamar
2025-11-18[DOC] Add documentation about Ruby's VM stackStan Lo
2025-11-17Remove alternation pattern matching handling from the prism compilerEarlopain
Since https://github.com/ruby/ruby/pull/15212 these are proper syntax errors, so no need to handle this explicitly anymore. Also updated the example in the docs for this
2025-11-15[DOC] Remove an obsolete fileNobuyoshi Nakada
It has been merged into `doc/ruby/options.md` with `field_processing.md` at ruby/ruby#10138.
2025-11-15[Doc] Remove leftover references to namespace from box.mdHerwin
And fix the indentation a little bit, since `box` is one character longer than `ns`.
2025-11-14[Feature #21275] Bump Unicode version to 17.0.0Mari Imaizumi