summaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2023-11-26[DOC] Fix markupNobuyoshi Nakada
RDoc is not markdown.
2023-11-24[DOC] Mention `Time.find_timezone` methodNobuyoshi Nakada
2023-11-24[DOC] Add links about timezonesNobuyoshi Nakada
2023-11-23Add recommendations on link formatting in documentationBurdette Lamar
2023-11-20YJIT: make --yjit-max-versions=N option undocumented (#8962)Maxime Chevalier-Boisvert
Not useful for the vast majority of end users to change this option.
2023-11-14[DOC] Adjust heading levelsNobuyoshi Nakada
So that the first headings would be the top-most headings.
2023-11-14[DOC] Fix doc/regexp.rdoc linksNobuyoshi Nakada
- Rename regexp.rdoc to exclude from "Pages". This file is for to be included in the "class Regexp" document, but it also appeared as a separate page duplicately. - Fix links on case-sensitive filesystems. - Fix to use rdoc-ref instead of converted HTML page names.
2023-11-13[ruby/reline] Fallback to 256color if COLORTERM != truecolortomoya ishida
(https://github.com/ruby/reline/pull/604) * Fallback to 256color if COLORTERM != truecolor * Add Reline::Face.force_truecolor to force truecolor without COLORTERM env https://github.com/ruby/reline/commit/090e1e4df0
2023-11-13[DOC] Close a tagNobuyoshi Nakada
2023-11-13[DOC] Fix Timezone Objects descriptionNobuyoshi Nakada
From the beginning when Timezone object support was introduced, Timezone objects are allowed everywhere offset strings are allowed.
2023-11-10Add "Optimization" section to regexp.rdoc (#8849)Hiroya Fujinami
* Add "Optimization" section to regexp.rdoc * Apply the suggestions by @BurdetteLamar --------- Co-authored-by: Burdette Lamar <[email protected]>
2023-11-09[DOC] Fix typosNobuyoshi Nakada
2023-11-07YJIT: update yjit.md, add MPLR 2023 paper and bibtex (#8861)Maxime Chevalier-Boisvert
* YJIT: update yjit.md, add MPLR 2023 paper and bibtex * Update doc/yjit/yjit.md
2023-11-06[DOC] Use a relative link like other linksTakashi Kokubun
following up on https://github.com/ruby/ruby/pull/8832
2023-11-06[ruby/reline] Introduce a new class Reline::Face to configureHASUMI Hitoshi
character attributes (https://github.com/ruby/reline/pull/552) * Reine::Face * fix test_yamatanooroti * Define singleton methods to make accessors to attributes of a face * s/display/foreground/ * s/default/default_style/ && s/normal_line/default/ && s/enhanced_line/enhanced/ * fix typo * FaceConfig.new now takes keyword arguments * Update lib/reline/face.rb Co-authored-by: Stan Lo <[email protected]> * Update test/reline/test_face.rb Co-authored-by: Stan Lo <[email protected]> * Fix to correspond to frozen_string_literal * Face::FaceConfig -> Face::Config * ref https://github.com/ruby/reline/pull/552#pullrequestreview-1677282576 * delete unused ivar * ref https://github.com/ruby/reline/pull/552#discussion_r1358783723 * insert "\e[0m" into all SGR * tiny fix * ESSENTIAL_DEFINE_NAMES ref https://github.com/ruby/reline/pull/552#discussion_r1367722247 * Change to Hash-accessor style - Reline::Face[:completion_dialog].enhanced -> Reline::Face[:completion_dialog][:enhanced] - Reline::Face.configs shows all defined values * Cache array method call in local variable * Tests for Face configuration variations * resolve https://github.com/ruby/reline/pull/552#pullrequestreview-1710938154 * amend to * check invalid SGR parameter in :style * The order of define values should be preserved * Update test/reline/test_face.rb Co-authored-by: Stan Lo <[email protected]> * Update test/reline/test_face.rb Co-authored-by: Stan Lo <[email protected]> * Add methods: load_initial_config and reset_to_initial_config. And teardown in tests * omission in amending "style: :default" to "style: :reset" * refs https://github.com/ruby/reline/issues/598 * Fix link * amend method name * Update lib/reline/face.rb Co-authored-by: ima1zumi <[email protected]> --------- https://github.com/ruby/reline/commit/fdc1d3b1e5 Co-authored-by: Stan Lo <[email protected]> Co-authored-by: ima1zumi <[email protected]>
2023-11-06Updated building_ruby.md to include reference for building on WindowsJorandeBoer
Looking at building_ruby.md it is unclear that you are able to build Ruby on Windows. To fix that a reference has been added to the windows.md file.
2023-11-02Windows: Fix description of runtimesLars Kanis
`mswin` platform links to `vcruntimeXXX.dll` but `mingw-ucrt` doesn't.
2023-11-01List prism as a default gemKevin Newton
2023-10-28Windows: Add libffi as a build dependencyLars Kanis
Otherwise the fiddle extension isn't build.
2023-10-22[DOC] Mention the omission of a superclass when reopening a classKouhei Yanagita
2023-10-20[DOC] `configure -C` tipsNobuyoshi Nakada
2023-10-20[DOC] Improve docs for how to generate documentationMatheus Richard
It might not be obvious how to get the build directory and the Makefile set up.
2023-10-19YJIT: remove unused `--yjit-greedy-versioning` command-line option (#8713)Maxime Chevalier-Boisvert
2023-10-18YJIT: Add --yjit-perf (#8697)Takashi Kokubun
Co-authored-by: Alan Wu <[email protected]>
2023-10-14[DOC] testing_ruby.md: Add spec/ for the explanation of the `make check`.Jun Aruga
2023-10-14[DOC] testing_ruby.md: Remove the command prompt '$ ` aligning with other parts.Jun Aruga
Remove the command prompt '$ ` aligning with other parts in the document.
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 <[email protected]>
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 <[email protected]> * Shorten help string to appease test * Address bug found by Kokubun. Reorder logic. --------- Co-authored-by: Alan Wu <[email protected]> Co-authored-by: Jean byroot Boussier <[email protected]>
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 <[email protected]> doc: Update doc/syntax/operators.rdoc align format of other examples with rest of documentation Co-authored-by: Nobuyoshi Nakada <[email protected]> Update doc/syntax/operators.rdoc align format of other examples with rest of documentation Co-authored-by: Nobuyoshi Nakada <[email protected]> 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 <[email protected]>
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 <[email protected]>
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 <[email protected]> Notes: Merged-By: ioquatix <[email protected]>
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 <[email protected]>
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 <[email protected]>
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