summaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
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-17Update yjit.mdMaxime Chevalier-Boisvert
2023-01-16[DOC] Update `String#encode` special caseNobuyoshi Nakada
This behavior has been slightly extended with the addition of `String#scrub`.
2023-01-16[DOC] Explain that transcoding to the same encoding just copies.Martin Dürst
This is a reenstatement of the explanation in commit 463633e4a934a00f869086a6ffbf84c6cb8ad630 to partially address Bug #19342.
2023-01-16[DOC] Use RDoc inclusions in transcode.cNobuyoshi Nakada
Notes: Merged: https://github.com/ruby/ruby/pull/7126
2023-01-13[DOC] Fix markup [ci skip]Kazuhiro NISHIYAMA
2023-01-11[DOC] Mention the conditional regexpNobuyoshi Nakada
Notes: Merged: https://github.com/ruby/ruby/pull/7103
2023-01-09Update yjit.mdMaxime Chevalier-Boisvert
Add Alan Wu's keynote & Maxime's talk to the list of YJIT-related talks :)
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
2023-01-06Fix typos [ci skip]Kazuhiro NISHIYAMA
2022-12-29[DOC] remove space from inside code span elementJohn Bampton
Notes: Merged: https://github.com/ruby/ruby/pull/7036 Merged-By: nobu <nobu@ruby-lang.org>
2022-12-26[DOC] Un-capitalize headingsNobuyoshi Nakada
Notes: Merged: https://github.com/ruby/ruby/pull/7027
2022-12-26[DOC] Update extension.rdocNobuyoshi Nakada
Refine the uses of word "Data", which were often ambiguous. Also, that word now refers the new class unrelated to `T_DATA`. Notes: Merged: https://github.com/ruby/ruby/pull/7027
2022-12-26Copy NEWS.md to doc/NEWS/NEWS-3.2.0.md [ci skip]Kazuhiro NISHIYAMA
2022-12-22Remove mjit.md from public documentation [ci skip]Takashi Kokubun
It's for CRuby developers. Not meant to be a documentation for users. Creating a directory seems like the easiest way to exclude this from doc/.document.
2022-12-22Update MJIT documentation [ci skip]Takashi Kokubun
2022-12-22[DOC] encodings.rdoc: universal_newline reacts to \rAlan Wu
It wasn't clear that the mode also translates "\r" to "\n". Notes: Merged: https://github.com/ruby/ruby/pull/6981
2022-12-20Array#pack: document silent truncationJean Boussier
Ref: [Feature #19245] At the very least this behavior should be documented. Notes: Merged: https://github.com/ruby/ruby/pull/6969
2022-12-19Syntax-highlight scripts in yjit.md [ci skip]Takashi Kokubun
Specifically, I wanted to grey out comments in shell scripts. But I just specified a language for blocks without comments as well to avoid forgetting that in the future.
2022-12-08Use a ruby-lang alias [ci skip]Takashi Kokubun
2022-12-07Update yjit.mdMaxime Chevalier-Boisvert
Update citation, fix outdated and inaccurate information.
2022-11-28Update yjit.md to mention `RUBY_YJIT_ENABLE`Maxime Chevalier-Boisvert
2022-11-22Update yjit.mdMaxime Chevalier-Boisvert
2022-11-21YJIT: Lower the required Rust version from 1.58.1 to 1.58.0 (#6780)Takashi Kokubun
Notes: Merged-By: k0kubun <takashikkbn@gmail.com>
2022-11-19[ruby/net-http] About the Examples moved to separate fileBurdetteLamar
https://github.com/ruby/net-http/commit/0512b5bfc9
2022-11-13Update yjit.mdMaxime Chevalier-Boisvert
Remove disclaimer
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-09[DOC] Enhanced RDoc for IO (#6669)Burdette Lamar
Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
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-11-02Update Regexp.timeout doc (#6658)Sampat Badhe
* Correct Regexp.timeout doc, Timeout.timeout= => Regexp.timeout= * add link Regexp Timeout section Notes: Merged-By: nobu <nobu@ruby-lang.org>
2022-10-29[DOC] Enhanced RDOc for IO (#6642)Burdette Lamar
In io.c treats: #close #close_read #close_write #closed Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
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 <maximecb@ruby-lang.org>
2022-10-24[DOC] Revert previous merge (#6624)Burdette Lamar
Revert previous merge Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-10-24[DOC] Add note about method names (#6620)Burdette Lamar
Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-10-22[rubygems/rubygems] Allow upcoming JRuby to pass keywords for Kernel#warnThomas E. Enebo
jruby-head (which will be JRuby 9.4.0.0) can now properly process the keywords to Kernel#warn. I cannot think of any capability based test for this so I constrained it using a version guard. Only JRuby will ever hit the version guard. https://github.com/rubygems/rubygems/commit/cd468c7e0f
2022-10-21[DOC] Add link targets (#6602)Burdette Lamar
Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-10-19[DOC] More about line number (#6582)Burdette Lamar
Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-10-18[DOC] Link to packed data doc (#6567)Burdette Lamar
* Link to packed data doc * Update pack.rb Co-authored-by: Peter Zhu <peter@peterzhu.ca> * Update pack.rb Co-authored-by: Peter Zhu <peter@peterzhu.ca> * Update pack.rb Co-authored-by: Peter Zhu <peter@peterzhu.ca> Co-authored-by: Peter Zhu <peter@peterzhu.ca> Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-10-15[DOC] Packed data (#6520)Burdette Lamar
New page for packed data Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-10-14Update yjit docs (#6548)Eileen M. Uchitelle
* The list of supported architectures was updated in https://github.com/ruby/ruby/commit/5ef048e5b1c3dd61adf782ace570bb0a1f9bb12f but the first paragraph wasn't updated. * `--yjit-trace-exits` was missing from the command-line options * Fixes some spacing issues * Updates call threshold default to 10, verified in the code that's correct. * Add code ticks around method names. * Fix namespace of stats example Notes: Merged-By: k0kubun <takashikkbn@gmail.com>
2022-10-08Fix a typo Denail-of-Service => Denial-of-Service [ci skip]sampatbadhe
Notes: Merged: https://github.com/ruby/ruby/pull/6510
2022-10-06Adapt doc guide to new GFM features (#6504)Burdette Lamar
* Adapt doc guide to new GFM features * Adapt doc guide to new GFM features Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-10-04[DOC] Adding remarks about HTML and tables (#6485)Burdette Lamar
* Adding remarks about HTML and tables Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-09-27[DOC] More on IO streams (#6454)Burdette Lamar
Adds remarks about .new and .open. Uses ..open where convenient (not convenient where output would be in a block). Fixed examples for #ungetc. Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>