summaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
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>
2022-09-27[DOC] More on IO streams (#6445)Burdette Lamar
Text is reorganized so that most of the previous text is now in these newly-created sections: Basic IO Line IO New text is added to form new sections: Character IO Byte IO Codepoint IO This gives the page a functional orientation, so that a reader can quickly find pertinent sections. The page retains its original mission: to provide good link targets for the doc for related classes. Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-09-23[DOC] Housekeeping in iostreams doc (#6420)Burdette Lamar
Write some method names in linkable form; make some capitalization consistent. Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-09-21New page IO Streams (#6383)Burdette Lamar
This page provides an overview of IO streams. It's meant to be linked to from many other doc spots. In particular it will be linked to from many places in ARGF, File, IO, and StringIO. Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-09-21Add URI.escape and URI.unescape to NEWS-3.0.0 [ci skip]Akihiro Sada
Notes: Merged: https://github.com/ruby/ruby/pull/5764
2022-09-19Stop recommending duplicated options [ci skip] (#6400)Takashi Kokubun
Notes: Merged-By: k0kubun <takashikkbn@gmail.com>
2022-09-05[DOC] [Bug #17120] Fix match-reset `\K`Nobuyoshi Nakada
2022-09-05Stop testing MJIT on s390xTakashi Kokubun
It didn't work either. http://rubyci.s3.amazonaws.com/s390x/ruby-master/log/20220905T080003Z.fail.html.gz
2022-09-05Update MJIT doc about bindgen and platforms [ci skip]Takashi Kokubun
2022-09-03[DOC] Escape backqoute method not to be converted to smart quotesNobuyoshi Nakada
2022-08-31It was a relative path [ci skip]Takashi Kokubun
2022-08-31Add a document about YJIT's Rust versionTakashi Kokubun
2022-08-31[DOC] Enhanced RDoc for Time (#6308)Burdette Lamar
More on timezones. Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-08-30Put a documentation about MJIT [ci skip]Takashi Kokubun
2022-08-29Update yjit.mdMaxime Chevalier-Boisvert
Add VMIL paper, update supported CPUs. Notes: Merged: https://github.com/ruby/ruby/pull/6289
2022-08-25[DOC] Enhanced RDoc for Time (#6277)Burdette Lamar
Deletes the :include: files in doc/time, which became no longer workable when @nobu pointed out that some (but not all) creator methods accept string values as well as integer-like values. Changes to methods: Time.utc Time.local Time.at Time.new Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-08-22[DOC] Addition to section 'Related Methods' (#6271)Burdette Lamar
Addition to section 'Related Methods': suggests adding differentiators to the names of related methods. Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-08-22[DOC] Enhanced RDoc for Time (#6267)Burdette Lamar
Treats: #utc #getlocal #getutc #ctime #to_s #inspect Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>