aboutsummaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* [DOC] Fix markup in declarative marking API documentNobuyoshi Nakada2023-11-261-7/+7
| | | | | | | - RDoc is not markdown, use `+` and `_` for code and variables respectively, instead of backquotes. - Remove useless backslashes.
* [DOC] Fix markupNobuyoshi Nakada2023-11-261-2/+2
| | | | RDoc is not markdown.
* [DOC] Mention `Time.find_timezone` methodNobuyoshi Nakada2023-11-241-0/+27
|
* [DOC] Add links about timezonesNobuyoshi Nakada2023-11-241-1/+3
|
* Add recommendations on link formatting in documentationBurdette Lamar2023-11-231-0/+30
|
* YJIT: make --yjit-max-versions=N option undocumented (#8962)Maxime Chevalier-Boisvert2023-11-201-1/+0
| | | | Not useful for the vast majority of end users to change this option.
* [DOC] Adjust heading levelsNobuyoshi Nakada2023-11-1412-177/+177
| | | | So that the first headings would be the top-most headings.
* [DOC] Fix doc/regexp.rdoc linksNobuyoshi Nakada2023-11-142-37/+36
| | | | | | | | - 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.
* [ruby/reline] Fallback to 256color if COLORTERM != truecolortomoya ishida2023-11-131-3/+6
| | | | | | | | | | (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
* [DOC] Close a tagNobuyoshi Nakada2023-11-131-1/+1
|
* [DOC] Fix Timezone Objects descriptionNobuyoshi Nakada2023-11-131-7/+1
| | | | | From the beginning when Timezone object support was introduced, Timezone objects are allowed everywhere offset strings are allowed.
* Add "Optimization" section to regexp.rdoc (#8849)Hiroya Fujinami2023-11-101-0/+27
| | | | | | | | | * Add "Optimization" section to regexp.rdoc * Apply the suggestions by @BurdetteLamar --------- Co-authored-by: Burdette Lamar <BurdetteLamar@Yahoo.com>
* [DOC] Fix typosNobuyoshi Nakada2023-11-091-2/+2
|
* YJIT: update yjit.md, add MPLR 2023 paper and bibtex (#8861)Maxime Chevalier-Boisvert2023-11-071-14/+15
| | | | | * YJIT: update yjit.md, add MPLR 2023 paper and bibtex * Update doc/yjit/yjit.md
* [DOC] Use a relative link like other linksTakashi Kokubun2023-11-061-1/+1
| | | | following up on https://github.com/ruby/ruby/pull/8832
* [ruby/reline] Introduce a new class Reline::Face to configureHASUMI Hitoshi2023-11-061-0/+108
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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 <stan001212@gmail.com> * Update test/reline/test_face.rb Co-authored-by: Stan Lo <stan001212@gmail.com> * 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 <stan001212@gmail.com> * Update test/reline/test_face.rb Co-authored-by: Stan Lo <stan001212@gmail.com> * 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 <52617472+ima1zumi@users.noreply.github.com> --------- https://github.com/ruby/reline/commit/fdc1d3b1e5 Co-authored-by: Stan Lo <stan001212@gmail.com> Co-authored-by: ima1zumi <52617472+ima1zumi@users.noreply.github.com>
* Updated building_ruby.md to include reference for building on WindowsJorandeBoer2023-11-061-0/+4
| | | 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.
* Windows: Fix description of runtimesLars Kanis2023-11-021-2/+2
| | | `mswin` platform links to `vcruntimeXXX.dll` but `mingw-ucrt` doesn't.
* List prism as a default gemKevin Newton2023-11-012-0/+7
|
* Windows: Add libffi as a build dependencyLars Kanis2023-10-281-2/+2
| | | Otherwise the fiddle extension isn't build.
* [DOC] Mention the omission of a superclass when reopening a classKouhei Yanagita2023-10-221-3/+25
|
* [DOC] `configure -C` tipsNobuyoshi Nakada2023-10-201-0/+2
|
* [DOC] Improve docs for how to generate documentationMatheus Richard2023-10-201-1/+3
| | | | It might not be obvious how to get the build directory and the Makefile set up.
* YJIT: remove unused `--yjit-greedy-versioning` command-line option (#8713)Maxime Chevalier-Boisvert2023-10-191-2/+1
|
* YJIT: Add --yjit-perf (#8697)Takashi Kokubun2023-10-181-0/+28
| | | Co-authored-by: Alan Wu <alansi.xingwu@shopify.com>
* [DOC] testing_ruby.md: Add spec/ for the explanation of the `make check`.Jun Aruga2023-10-141-1/+1
|
* [DOC] testing_ruby.md: Remove the command prompt '$ ` aligning with other parts.Jun Aruga2023-10-141-2/+2
| | | | Remove the command prompt '$ ` aligning with other parts in the document.
* Fix Typoαlpha 0x002023-10-111-1/+1
|
* YJIT: Allow --yjit-trace-exits on release builds (#8619)Takashi Kokubun2023-10-101-1/+1
|
* Integer#times is not a C method [ci skip]Takashi Kokubun2023-10-101-1/+1
|
* Update yjit.mdMaxime Chevalier-Boisvert2023-10-101-5/+6
|
* testing_ruby.md: Document running test suites on s390x CPU architecture [ci ↵Jun Aruga2023-10-091-0/+12
| | | | skip] (#8589)
* [DOC] Fix platform-dependent directives and modifiersNobuyoshi Nakada2023-10-061-20/+17
| | | | | | | | * '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>
* YJIT: add heuristic to avoid compiling cold ISEQs (#8522)Maxime Chevalier-Boisvert2023-10-031-1/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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>
* [DOC] Correction for doc guide + TOC fix in File (#8505)Burdette Lamar2023-09-241-8/+13
|
* doc: initial operators commitNicholas Browning2023-09-202-0/+78
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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
* [DOC] Add production performance tips to yjit.md (#8472)Takashi Kokubun2023-09-181-4/+53
| | | Co-authored-by: Maxime Chevalier-Boisvert <maxime.chevalierboisvert@shopify.com>
* [DOC] Mention "-" in ARGFNobuyoshi Nakada2023-09-171-4/+7
|
* [DOC] Globals doc (#8445)Burdette Lamar2023-09-151-69/+419
|
* Fix hyperlink for Script EncodingHerwin2023-09-131-1/+1
|
* [DOC] Update Reline and IRB's maintainers list (#8406)Stan Lo2023-09-081-2/+8
| | | | | | 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.
* [ruby/irb] Remove unused `PROMPT_N`Summer ☀️2023-08-291-3/+1
| | | | | | (https://github.com/ruby/irb/pull/685) https://github.com/ruby/irb/commit/66e69fa0dc
* Add documentation regarding how to build Ruby for debugging. (#8290)Samuel Williams2023-08-261-0/+8
| | | Co-authored-by: Nobuyoshi Nakada <nobu@ruby-lang.org>
* Change yjit stats list to be a unordered listRafael Mendonça França2023-08-231-11/+11
| | | Without using a list, this show as a single paragraph with all stats descriptions being in one single line
* [DOC] Adding font usage to doc guide (#8255)Burdette Lamar2023-08-231-4/+38
|
* Update yjit.md, document `--yjit-stats=quiet`Maxime Chevalier-Boisvert2023-08-211-5/+4
|
* [DOC] Update to use `SPECOPTS` instead of `MSPECOPT`Nobuyoshi Nakada2023-08-121-6/+6
|
* [DOC] Don't suppress autolinks (#8207)Burdette Lamar2023-08-111-0/+6
|
* Deprecate Kernel#open and IO support for subprocess creation/forkingMike Dalessio2023-08-101-0/+2
| | | | | | | | | | | | | | | | | 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]
* [ruby/optparse] [DOC] Corrections to tutorialBurdetteLamar2023-07-311-13/+13
| | | | https://github.com/ruby/optparse/commit/2940dbb65a
generated by cgit v1.2.3 (git 2.39.1) at 2024-10-01 20:21:32 +0000