summaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2023-10-11Fix Typoαlpha 0x00
2023-10-10YJIT: Allow --yjit-trace-exits on release builds (#8619)Takashi Kokubun
2023-10-10Integer#times is not a C method [ci skip]Takashi Kokubun
2023-10-10Update yjit.mdMaxime Chevalier-Boisvert
2023-10-09testing_ruby.md: Document running test suites on s390x CPU architecture [ci ↵Jun Aruga
skip] (#8589)
2023-10-06[DOC] Fix platform-dependent directives and modifiersNobuyoshi Nakada
* 'j' and 'J' are not pointer directives. * size of 'j' and 'J' are platform-dependent, may not be 64-bit. * mention corresponding C types when native-size modifier is added. Co-Authored-By: BurdetteLamar <burdettelamar@yahoo.com>
2023-10-03YJIT: add heuristic to avoid compiling cold ISEQs (#8522)Maxime Chevalier-Boisvert
* YJIT: Add counter to measure how often we compile "cold" ISEQs (#535) Fix counter name in DEFAULT_COUNTERS YJIT: add --yjit-cold-threshold, don't compile cold ISEQs YJIT: increase default cold threshold to 200_000 Remove rb_yjit_call_threshold() Remove conflict markers Fix compilation errors Threshold 1 should compile immediately Debug deadlock issue with test_ractor Fix call threshold issue with tests * Revert exception threshold logic. Document option in yjid.md * (void) for 0 parameter functions in C99 * Rename iseq_entry_cold => cold_iseq_entry * Document --yjit-cold-threshold in ruby.c * Update doc/yjit/yjit.md Co-authored-by: Jean byroot Boussier <jean.boussier+github@shopify.com> * Shorten help string to appease test * Address bug found by Kokubun. Reorder logic. --------- Co-authored-by: Alan Wu <XrXr@users.noreply.github.com> Co-authored-by: Jean byroot Boussier <jean.boussier+github@shopify.com>
2023-09-24[DOC] Correction for doc guide + TOC fix in File (#8505)Burdette Lamar
2023-09-20doc: initial operators commitNicholas Browning
docs: expand on operator documentaion Include more specific details around logical operators. doc: update link with proper syntax doc: remove ambiguous language from operators doc doc: remove link to source code file doc: cleaning up some language, and removing some mistakes in understanding doc: revert example to prior state doc: fix spacing doc: Update doc/syntax/operators.rdoc align example with typical format Co-authored-by: Nobuyoshi Nakada <nobu@ruby-lang.org> doc: Update doc/syntax/operators.rdoc align format of other examples with rest of documentation Co-authored-by: Nobuyoshi Nakada <nobu@ruby-lang.org> Update doc/syntax/operators.rdoc align format of other examples with rest of documentation Co-authored-by: Nobuyoshi Nakada <nobu@ruby-lang.org> doc: include `and` & `or` operators doc(operators): remove accute language
2023-09-18[DOC] Add production performance tips to yjit.md (#8472)Takashi Kokubun
Co-authored-by: Maxime Chevalier-Boisvert <maxime.chevalierboisvert@shopify.com>
2023-09-17[DOC] Mention "-" in ARGFNobuyoshi Nakada
2023-09-15[DOC] Globals doc (#8445)Burdette Lamar
2023-09-13Fix hyperlink for Script EncodingHerwin
Notes: Merged: https://github.com/ruby/ruby/pull/8432
2023-09-08[DOC] Update Reline and IRB's maintainers list (#8406)Stan Lo
Update Reline and IRB's maintainers list Maintainers' order follows the same order they appear in the projects' contributors list as of the time this commit is made. Notes: Merged-By: k0kubun <takashikkbn@gmail.com>
2023-08-29[ruby/irb] Remove unused `PROMPT_N`Summer ☀️
(https://github.com/ruby/irb/pull/685) https://github.com/ruby/irb/commit/66e69fa0dc
2023-08-26Add documentation regarding how to build Ruby for debugging. (#8290)Samuel Williams
Co-authored-by: Nobuyoshi Nakada <nobu@ruby-lang.org> Notes: Merged-By: ioquatix <samuel@codeotaku.com>
2023-08-23Change yjit stats list to be a unordered listRafael Mendonça França
Without using a list, this show as a single paragraph with all stats descriptions being in one single line Notes: Merged: https://github.com/ruby/ruby/pull/8268
2023-08-23[DOC] Adding font usage to doc guide (#8255)Burdette Lamar
Notes: Merged-By: peterzhu2118 <peter@peterzhu.ca>
2023-08-21Update yjit.md, document `--yjit-stats=quiet`Maxime Chevalier-Boisvert
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 <peter@peterzhu.ca>
2023-08-10Deprecate Kernel#open and IO support for subprocess creation/forkingMike Dalessio
Deprecate Kernel#open and IO support for subprocess creation and forking. This deprecates subprocess creation and forking in - Kernel#open - URI.open - IO.binread - IO.foreach - IO.readlines - IO.read - IO.write This behavior is slated to be removed in Ruby 4.0 [Feature #19630] Notes: Merged: https://github.com/ruby/ruby/pull/7915
2023-07-31[ruby/optparse] [DOC] Corrections to tutorialBurdetteLamar
https://github.com/ruby/optparse/commit/2940dbb65a
2023-07-30[ruby/optparse] [DOC] Mark up constant and method names as codeNobuyoshi Nakada
https://github.com/ruby/optparse/commit/e8bee0be8f
2023-07-20YJIT: Rename exec_instruction to yjit_insns_count (#8102)Takashi Kokubun
Notes: Merged-By: maximecb <maximecb@ruby-lang.org>
2023-07-20YJIT: Avoid undercounting retired_in_yjit (#8038)Takashi Kokubun
* YJIT: Count the number of failed instructions * Rename yjit_insns_count to exec_instructions instead * Hoist out the exec_instruction counter Notes: Merged-By: maximecb <maximecb@ruby-lang.org>
2023-07-18[DOC] Fix a magic comment in the section for `experimental_copy`Ivanov-Anton
Notes: Merged: https://github.com/ruby/ruby/pull/8087 Merged-By: nobu <nobu@ruby-lang.org>
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-07-05Deleted unnecessary YARP fuzzing doc fileJemma Issroff
Notes: Merged: https://github.com/ruby/ruby/pull/8007
2023-07-01[Bug #19728] Auto-generate unicode property docsJanosch Müller
https://bugs.ruby-lang.org/issues/19728 Notes: Merged: https://github.com/ruby/ruby/pull/7944 Merged-By: nobu <nobu@ruby-lang.org>
2023-07-01[DOC] Move document for YARPNobuyoshi Nakada
2023-06-30[ruby/yarp] Move fuzz docs into docs/ directory, reference in READMEKevin Newton
https://github.com/ruby/yarp/commit/97547b6192
2023-06-29Fix broken wiki links (#8002)Jemma Issroff
Since [Misc #19679] migrated the wiki, these links should be updated to their new locations. Notes: Merged-By: jemmaissroff
2023-06-28Repair broken linkBurdetteLamar
Notes: Merged: https://github.com/ruby/ruby/pull/7993
2023-06-28[DOC] Fixes for link fragments (#7981)Burdette Lamar
Notes: Merged-By: peterzhu2118 <peter@peterzhu.ca>
2023-06-28[ruby/csv] docs: Add entry for backslash_quotes liberal parsingMark Schneider
(https://github.com/ruby/csv/pull/280) https://github.com/ruby/csv/commit/0dcfcd9c48
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-06-25[DOC] Parse documents under doc/yjitNobuyoshi Nakada
2023-06-25[DOC] Parse all documents under doc/regexpNobuyoshi Nakada
2023-06-20[DOC] Regexp doc (#7923)Burdette Lamar
Notes: Merged-By: peterzhu2118 <peter@peterzhu.ca>
2023-06-20Update Racc entries on documentsHiroshi SHIBATA
2023-06-16[ruby/rdoc] Fix missing closing colon for `:notnew:`zzak
https://github.com/ruby/rdoc/commit/1e550b7d02
2023-06-13Update the current URI maintainerHiroshi SHIBATA
2023-05-26Document throw/catch in the control expressions document [ci skip]Jeremy Evans
This are implemented as Kernel methods and not keywords, but I still think they are worth documenting with the other control flow expressions. Notes: Merged: https://github.com/ruby/ruby/pull/7856 Merged-By: jeremyevans <code@jeremyevans.net>
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-25[ruby/csv] docs: fix example in Recipe: Capture Unconverted FieldsYuki Tsujimoto
(https://github.com/ruby/csv/pull/276) I've fixed the example in `Recipe: Capture Unconverted Fields`. https://ruby.github.io/csv/doc/csv/recipes/parsing_rdoc.html#label-Recipe-3A+Capture+Unconverted+Fields `parsed` is wrong: header row is missing and the values should be integers. ``` $ ruby -v ruby 3.2.1 (2023-02-08 revision https://github.com/ruby/csv/commit/31819e82c8) [x86_64-darwin21] $ cat unconverted_fields.rb require "csv" source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n" parsed = CSV.parse(source, converters: :integer, unconverted_fields: true) p parsed parsed.each {|row| p row.unconverted_fields } $ ruby unconverted_fields.rb [["Name", "Value"], ["foo", 0], ["bar", 1], ["baz", 2]] ["Name", "Value"] ["foo", "0"] ["bar", "1"] ["baz", "2"] ``` Notes: Merged: https://github.com/ruby/ruby/pull/7851
2023-05-25[ruby/csv] Fix typos (https://github.com/ruby/csv/pull/236)Sampat Badhe
https://github.com/ruby/csv/commit/d5e401266f Notes: Merged: https://github.com/ruby/ruby/pull/7851
2023-05-25[ruby/csv] Small RDoc changes for recipesBurdette Lamar
(https://github.com/ruby/csv/pull/190) https://github.com/ruby/csv/commit/2102c78384 Notes: Merged: https://github.com/ruby/ruby/pull/7851
2023-05-25[ruby/csv] Enhanced RDoc for CSV::TableBurdette Lamar
(https://github.com/ruby/csv/pull/166) https://github.com/ruby/csv/commit/1d685aede3 Notes: Merged: https://github.com/ruby/ruby/pull/7851