Nobuyoshi Nakada
c452fe17ac
[Bug #20087 ] [DOC] Uninitialized instance variable is not warned now
2023-12-27 01:10:30 +09:00
Nobuyoshi Nakada
af4e839c47
[ruby/optparse] [DOC] Add missing secition
...
Fixes https://github.com/ruby/optparse/pull/51
https://github.com/ruby/optparse/commit/667ab35f59
2023-12-25 21:12:49 +09:00
Nobuyoshi Nakada
7dd59346a0
[ruby/optparse] [DOC] Fix tutorial link
...
Fixes https://github.com/ruby/optparse/pull/51
https://github.com/ruby/optparse/commit/1c895efc39
2023-12-25 21:12:49 +09:00
Takashi Kokubun
0d175ec425
Copy 3.3.0 NEWS.md to doc/NEWS [ci skip]
...
Basically 7d264e8e7b
but for 3.3.0.
2023-12-25 01:47:13 -08:00
Hiroshi SHIBATA
e233730846
Partly reverted c903cddf55
...
These are intentional words
2023-12-25 11:22:12 +09:00
Hiroshi SHIBATA
c903cddf55
Typofix under doc directory
2023-12-25 11:17:51 +09:00
Takashi Kokubun
3c18277629
RJIT: Clean up unnecessary documentation
2023-12-21 16:47:13 -08:00
Burdette Lamar
4ad1007fd2
[ruby/irb] [DOC] Change indexes.rdoc to indexes.md
...
(https://github.com/ruby/irb/pull/812 )
* Change indexes.rdoc to indexes.md
* Change indexes.rdoc to indexes.md
* Change indexes.rdoc to indexes.md
https://github.com/ruby/irb/commit/b1cd53cbf7
2023-12-20 19:11:02 +09:00
Doug Orleans
1822acdf33
[DOC] remove reference to pre-3.0 splat operator behavior
2023-12-19 22:11:11 +09:00
Nobuyoshi Nakada
a94f3f206e
[DOC] Added notes regarding `:nodoc:` in C code
2023-12-18 20:17:44 +09:00
Takashi Kokubun
d8978445ae
Improve YJIT documentation for Ruby 3.3 ( #9263 )
2023-12-17 23:45:09 -05:00
Takashi Kokubun
b266890dab
YJIT: Add --yjit-disable to help and reorder it ( #9230 )
2023-12-13 13:29:37 -08:00
Burdette Lamar
35990cb38c
[ruby/irb] [DOC] RDoc for module IRB
...
(https://github.com/ruby/irb/pull/738 )
[DOC] RDoc for module IRB
https://github.com/ruby/irb/commit/f3a0626298
2023-12-12 10:34:38 +00:00
Nobuyoshi Nakada
bf0c8055ab
[DOC] Fix wording in descriptions of Time-like objects
...
Co-authored-by: Burdette Lamar <BurdetteLamar@Yahoo.com>
2023-12-05 18:10:56 +09:00
Nobuyoshi Nakada
bf0f56e124
[DOC] Mention Time-like objects
2023-12-05 18:04:02 +09:00
Burdette Lamar
715cf9b690
[DOC] More on What's Here ( #9099 )
...
* More on What's Here
* More on What's Here
2023-12-02 11:46:57 -06:00
Nobuyoshi Nakada
092a17e7bd
[DOC] Markup class name `Time` as code
2023-12-02 21:48:00 +09:00
Nobuyoshi Nakada
ae3e9f114c
[DOC] Include timezones document in timev.rb
...
So that it can be referred as a part of the document of `Time`.
2023-12-02 21:46:52 +09:00
Jeremy Evans
060f14bf62
Update documentation for [[:word:]] and \p{Word} in regexps
...
Onigmo uses Decimal_Number and not Number for these.
Fixes [Bug #19417 ]
2023-11-30 10:40:40 -08:00
Nobuyoshi Nakada
0cdad3b92a
Add `RUBY_REFERENCES`
...
Instead of `RUBY_REFERENCES_START` and `RUBY_REFERENCES_END`, so that
auto-indent works well.
2023-11-30 21:39:28 +09:00
Nobuyoshi Nakada
30f7b7a053
Prefix `REF_EDGE` and `REFS_LIST_PTR` with `RUBY_`
...
Also move `struct` so that `typedef`-ed names can be used.
2023-11-30 21:39:28 +09:00
Maxime Chevalier-Boisvert
8d1138c1cf
YJIT: edit `yjit.md` and bring it up to date ( #9068 )
...
Also make various minor edits to improve readability.
2023-11-29 18:09:55 -05:00
Maxime Chevalier-Boisvert
6310522a9a
YJIT: reduce default exec-mem-size to 64MiB ( #9054 )
2023-11-28 20:04:33 +00:00
Nobuyoshi Nakada
688faa93f0
[DOC] Fix markup in declarative marking API document
...
- RDoc is not markdown, use `+` and `_` for code and variables
respectively, instead of backquotes.
- Remove useless backslashes.
2023-11-26 21:49:18 +09:00
Nobuyoshi Nakada
087a919ea4
[DOC] Fix markup
...
RDoc is not markdown.
2023-11-26 19:18:57 +09:00
Nobuyoshi Nakada
0c0875fe60
[DOC] Mention `Time.find_timezone` method
2023-11-24 19:38:55 +09:00
Nobuyoshi Nakada
9d7ac1ba1c
[DOC] Add links about timezones
2023-11-24 19:38:55 +09:00
Burdette Lamar
12f4e9655e
Add recommendations on link formatting in documentation
2023-11-23 20:39:24 -08:00
Maxime Chevalier-Boisvert
f9628fb4be
YJIT: make --yjit-max-versions=N option undocumented ( #8962 )
...
Not useful for the vast majority of end users to change
this option.
2023-11-20 21:26:18 +00:00
Nobuyoshi Nakada
19a7a7660c
[DOC] Adjust heading levels
...
So that the first headings would be the top-most headings.
2023-11-14 15:56:58 +09:00
Nobuyoshi Nakada
caa9881fde
[DOC] Fix doc/regexp.rdoc links
...
- 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-14 15:56:57 +09:00
tomoya ishida
90b49024c0
[ruby/reline] Fallback to 256color if COLORTERM != truecolor
...
(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 12:42:31 +00:00
Nobuyoshi Nakada
4376a17552
[DOC] Close a tag
2023-11-13 16:04:49 +09:00
Nobuyoshi Nakada
44a6a13cbe
[DOC] Fix Timezone Objects description
...
From the beginning when Timezone object support was introduced,
Timezone objects are allowed everywhere offset strings are allowed.
2023-11-13 15:59:03 +09:00
Hiroya Fujinami
c49adfab5d
Add "Optimization" section to regexp.rdoc ( #8849 )
...
* Add "Optimization" section to regexp.rdoc
* Apply the suggestions by @BurdetteLamar
---------
Co-authored-by: Burdette Lamar <BurdetteLamar@Yahoo.com>
2023-11-10 01:24:15 +09:00
Nobuyoshi Nakada
b73e087dbc
[DOC] Fix typos
2023-11-09 16:37:03 +09:00
Maxime Chevalier-Boisvert
d9d0938116
YJIT: update yjit.md, add MPLR 2023 paper and bibtex ( #8861 )
...
* YJIT: update yjit.md, add MPLR 2023 paper and bibtex
* Update doc/yjit/yjit.md
2023-11-07 17:46:07 +00:00
Takashi Kokubun
ee25ac49f3
[DOC] Use a relative link like other links
...
following up on https://github.com/ruby/ruby/pull/8832
2023-11-06 09:46:37 -08:00
HASUMI Hitoshi
16403f41ab
[ruby/reline] Introduce a new class Reline::Face to configure
...
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>
2023-11-06 14:40:42 +00:00
JorandeBoer
a763d085e4
Updated building_ruby.md to include reference for building on Windows
...
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-06 11:52:31 +09:00
Lars Kanis
7523ede7ba
Windows: Fix description of runtimes
...
`mswin` platform links to `vcruntimeXXX.dll` but `mingw-ucrt` doesn't.
2023-11-02 15:16:41 +09:00
Kevin Newton
d9cb75b741
List prism as a default gem
2023-11-01 22:16:33 -04:00
Lars Kanis
7e6204dd10
Windows: Add libffi as a build dependency
...
Otherwise the fiddle extension isn't build.
2023-10-28 10:44:16 +09:00
Kouhei Yanagita
b84e6fe93e
[DOC] Mention the omission of a superclass when reopening a class
2023-10-22 20:12:16 +09:00
Nobuyoshi Nakada
0061eaddc9
[DOC] `configure -C` tips
2023-10-20 16:33:23 +09:00
Matheus Richard
72f97ee06e
[DOC] Improve docs for how to generate documentation
...
It might not be obvious how to get the build directory and the Makefile
set up.
2023-10-20 08:45:07 +09:00
Maxime Chevalier-Boisvert
3e65115cef
YJIT: remove unused `--yjit-greedy-versioning` command-line option ( #8713 )
2023-10-19 19:29:31 +00:00
Takashi Kokubun
f51b92fe23
YJIT: Add --yjit-perf ( #8697 )
...
Co-authored-by: Alan Wu <alansi.xingwu@shopify.com>
2023-10-18 21:07:03 +00:00
Jun Aruga
13dafb210e
[DOC] testing_ruby.md: Add spec/ for the explanation of the `make check`.
2023-10-14 22:43:41 -07:00
Jun Aruga
df1887414a
[DOC] testing_ruby.md: Remove the command prompt '$ ` aligning with other parts.
...
Remove the command prompt '$ ` aligning with other parts in the document.
2023-10-14 22:43:41 -07:00
αlpha 0x00
94508a8a60
Fix Typo
2023-10-11 15:26:24 -07:00
Takashi Kokubun
4d0a619f71
YJIT: Allow --yjit-trace-exits on release builds ( #8619 )
2023-10-10 14:54:19 -07:00
Takashi Kokubun
ef7fa8bd0e
Integer#times is not a C method [ci skip]
2023-10-10 10:27:29 -07:00
Maxime Chevalier-Boisvert
a6d190fa4d
Update yjit.md
2023-10-10 13:10:47 -04:00
Jun Aruga
6c952ac600
testing_ruby.md: Document running test suites on s390x CPU architecture [ci skip] ( #8589 )
2023-10-09 17:05:51 +02:00
Nobuyoshi Nakada
7b8d472100
[DOC] Fix platform-dependent directives and modifiers
...
* '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-06 22:20:19 +09:00
Maxime Chevalier-Boisvert
ea491802fa
YJIT: add heuristic to avoid compiling cold ISEQs ( #8522 )
...
* 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-10-03 17:45:46 -04:00
Burdette Lamar
36cd2b2a52
[DOC] Correction for doc guide + TOC fix in File ( #8505 )
2023-09-24 17:57:21 -04:00
Nicholas Browning
53a373078d
doc: initial operators commit
...
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-20 23:52:52 +09:00
Takashi Kokubun
0a2c4a6091
[DOC] Add production performance tips to yjit.md ( #8472 )
...
Co-authored-by: Maxime Chevalier-Boisvert <maxime.chevalierboisvert@shopify.com>
2023-09-18 16:27:18 -07:00
Nobuyoshi Nakada
72772a3caa
[DOC] Mention "-" in ARGF
2023-09-17 22:05:58 +09:00
Burdette Lamar
e50b7bf784
[DOC] Globals doc ( #8445 )
2023-09-15 13:59:48 -04:00
Herwin
7f6c0efac7
Fix hyperlink for Script Encoding
2023-09-13 13:37:12 -04:00
Stan Lo
b635a66e95
[DOC] Update Reline and IRB's maintainers list ( #8406 )
...
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.
2023-09-08 16:08:32 -07:00
Summer ☀️
0cd92819c9
[ruby/irb] Remove unused `PROMPT_N`
...
(https://github.com/ruby/irb/pull/685 )
https://github.com/ruby/irb/commit/66e69fa0dc
2023-08-29 18:15:05 +09:00
Samuel Williams
b2d1c720ec
Add documentation regarding how to build Ruby for debugging. ( #8290 )
...
Co-authored-by: Nobuyoshi Nakada <nobu@ruby-lang.org>
2023-08-26 09:59:45 +12:00
Rafael Mendonça França
774845284f
Change yjit stats list to be a unordered list
...
Without using a list, this show as a single paragraph with all stats descriptions being in one single line
2023-08-23 19:20:55 +02:00
Burdette Lamar
448ff162c4
[DOC] Adding font usage to doc guide ( #8255 )
2023-08-23 10:09:24 -04:00
Maxime Chevalier-Boisvert
eee83af34c
Update yjit.md, document `--yjit-stats=quiet`
2023-08-21 16:24:06 -04:00
Nobuyoshi Nakada
6ebde04202
[DOC] Update to use `SPECOPTS` instead of `MSPECOPT`
2023-08-12 12:33:05 +09:00
Burdette Lamar
6ccc660d85
[DOC] Don't suppress autolinks ( #8207 )
2023-08-11 17:53:53 -04:00
Mike Dalessio
d2343368ab
Deprecate Kernel#open and IO support for subprocess creation/forking
...
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 ]
2023-08-10 09:38:11 +09:00
BurdetteLamar
60ac719acc
[ruby/optparse] [DOC] Corrections to tutorial
...
https://github.com/ruby/optparse/commit/2940dbb65a
2023-07-31 03:26:47 +00:00
Nobuyoshi Nakada
dfad14d83f
[ruby/optparse] [DOC] Mark up constant and method names as code
...
https://github.com/ruby/optparse/commit/e8bee0be8f
2023-07-30 02:35:22 +00:00
Takashi Kokubun
c4ef3d767b
YJIT: Rename exec_instruction to yjit_insns_count ( #8102 )
2023-07-20 15:54:59 -04:00
Takashi Kokubun
b41fc9b9a4
YJIT: Avoid undercounting retired_in_yjit ( #8038 )
...
* YJIT: Count the number of failed instructions
* Rename yjit_insns_count to exec_instructions instead
* Hoist out the exec_instruction counter
2023-07-20 13:14:25 -04:00
Ivanov-Anton
b89b7d8fdc
[DOC] Fix a magic comment in the section for `experimental_copy`
2023-07-18 19:23:27 +09:00
jinroq
ebb7552e6d
[Doc] Make build instructions easier to copy-and-paste
2023-07-14 12:52:33 -04:00
Jemma Issroff
163cdb4cd4
Deleted unnecessary YARP fuzzing doc file
2023-07-05 16:58:55 -04:00
Janosch Müller
08b3fb1152
[Bug #19728 ] Auto-generate unicode property docs
...
https://bugs.ruby-lang.org/issues/19728
2023-07-01 23:22:17 +09:00
Nobuyoshi Nakada
2952dbad5e
[DOC] Move document for YARP
2023-07-01 12:22:22 +09:00
Kevin Newton
d49a92d036
[ruby/yarp] Move fuzz docs into docs/ directory, reference in README
...
https://github.com/ruby/yarp/commit/97547b6192
2023-06-30 18:31:49 +00:00
Jemma Issroff
1272865a8e
Fix broken wiki links ( #8002 )
...
Since [Misc #19679 ] migrated the wiki, these links should be updated
to their new locations.
2023-06-29 17:00:40 -04:00
BurdetteLamar
8f9d58a962
Repair broken link
2023-06-28 12:01:16 -04:00
Burdette Lamar
6528cf9fcf
[DOC] Fixes for link fragments ( #7981 )
2023-06-28 09:05:43 -04:00
Mark Schneider
2098093fb4
[ruby/csv] docs: Add entry for backslash_quotes liberal parsing
...
(https://github.com/ruby/csv/pull/280 )
https://github.com/ruby/csv/commit/0dcfcd9c48
2023-06-28 16:37:08 +09:00
Nobuyoshi Nakada
dc940cc740
[DOC] Nested ordered lists need more indents
2023-06-26 18:25:21 +09:00
BurdetteLamar
ed587abffb
Fix broken links
2023-06-25 16:44:59 -04:00
Nobuyoshi Nakada
15ec072a42
[DOC] Parse documents under doc/yjit
2023-06-25 17:21:31 +09:00
Nobuyoshi Nakada
0a9ef0548b
[DOC] Parse all documents under doc/regexp
2023-06-25 17:21:31 +09:00
Burdette Lamar
932dd9f10e
[DOC] Regexp doc ( #7923 )
2023-06-20 09:28:21 -04:00
Hiroshi SHIBATA
44ad176fc2
Update Racc entries on documents
2023-06-20 13:34:28 +09:00
zzak
80dfe2bc4d
[ruby/rdoc] Fix missing closing colon for `:notnew:`
...
https://github.com/ruby/rdoc/commit/1e550b7d02
2023-06-16 08:54:12 +00:00
Hiroshi SHIBATA
3924dba552
Update the current URI maintainer
2023-06-13 12:28:33 +09:00
Jeremy Evans
618a04d211
Document throw/catch in the control expressions document [ci skip]
...
This are implemented as Kernel methods and not keywords, but I
still think they are worth documenting with the other control
flow expressions.
2023-05-26 07:58:40 -07:00
Jun Aruga
6d450d62fb
testing_ruby.md: Update `make test-all` tips [ci skip]
2023-05-26 09:19:38 -04:00
Yuki Tsujimoto
e151a2ff8e
[ruby/csv] docs: fix example in Recipe: Capture Unconverted Fields
...
(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"]
```
2023-05-25 01:44:17 +09:00
Sampat Badhe
55a900d9cc
[ruby/csv] Fix typos ( https://github.com/ruby/csv/pull/236 )
...
https://github.com/ruby/csv/commit/d5e401266f
2023-05-25 01:44:17 +09:00
Burdette Lamar
81c57ae7ac
[ruby/csv] Small RDoc changes for recipes
...
(https://github.com/ruby/csv/pull/190 )
https://github.com/ruby/csv/commit/2102c78384
2023-05-25 01:44:17 +09:00
Burdette Lamar
347afd39a3
[ruby/csv] Enhanced RDoc for CSV::Table
...
(https://github.com/ruby/csv/pull/166 )
https://github.com/ruby/csv/commit/1d685aede3
2023-05-25 01:44:17 +09:00
Noah Gibbs
3bd98e7a91
Add documentation for some stats counters, and generally about YJIT stats
2023-05-22 14:45:00 -07:00
Yuichiro Kaneko
a1b01e7701
Use Lrama LALR parser generator instead of Bison
...
https://bugs.ruby-lang.org/issues/19637
Co-authored-by: Nobuyoshi Nakada <nobu@ruby-lang.org>
2023-05-12 18:25:10 +09:00
Hiroshi SHIBATA
172077232e
readline or libedit is no longer required to build ruby
2023-05-10 09:55:27 +09:00
Hiroshi SHIBATA
aec4e2d678
Removed duplicated entry of readline.rb
2023-05-10 09:53:02 +09:00
Hiroshi SHIBATA
507801c6d7
ext/readline is retired
2023-05-10 09:52:33 +09:00
Jemma Issroff
6404a0f2f8
Fix broken link to maintainers page
2023-05-09 12:57:36 +09:00
Nobuyoshi Nakada
18b27185c3
[DOC] regexp absent operator
2023-05-04 12:32:43 +09:00
Takashi Kokubun
f2c367734f
Introduce --enable-rjit=disasm
2023-04-27 14:27:51 -07:00
Benoit Daloze
4dc2e5a850
Fix packed_data.rdoc
2023-04-15 16:09:04 +02:00
Adam Hess
7b27ad9ad3
Add BIN as an entry in the glossary ( #7667 )
...
I initially thought this macro is referencing binary, not basic instruction name
2023-04-05 16:11:04 -07:00
Maxime Chevalier-Boisvert
27ecf3261e
Update yjit.md
...
Document `make yjit-smoke-test`
2023-03-20 15:40:55 -04:00
Nobuyoshi Nakada
e7342e76df
[Bug #19485 ] [DOC] Mention tabs in indentation of heredoc identifier
...
Co-Authored-By: sawa (Tsuyoshi Sawada) <sawadatsuyoshi@gmail.com>
2023-03-19 18:10:55 +09:00
Takashi Kokubun
4e440d6990
RJIT: Install libcapstone-dev on CI
...
for test_assembler.rb to work
2023-03-18 21:26:09 -07:00
Takashi Kokubun
644c998525
RJIT: Support --rjit-stats on release build as well
2023-03-17 22:31:41 -07:00
git
cc68d692f8
* remove trailing spaces. [ci skip]
2023-03-17 19:20:53 +00:00
Matt Valentine-House
4f5e29f930
Document the declarative marking api
2023-03-17 19:20:40 +00:00
Takashi Kokubun
ac47b8df8f
Bump the required BASERUBY version to 2.5 ( #7504 )
...
[Misc #16671 ]
I'd like to bump it to 2.7 to use pattern matching in
tool/mk_builtin_loader.rb.
However, I experienced a few blockers. 2.5 seems like the closest
version that is easy enough to use on CIs, so let me bump the version to
it as an intermediate step for it. I want to use &. and <<~ in 2.3 too.
Known blockers:
* AppVeyor Visual Studio 2015 doesn't have Ruby 2.7. You'd need to bump
the version to Visual Studio 2019.
* GitHub Actions windows-2019 doesn't have Ruby 2.7 either. You
can use ruby/setup-ruby, but configure doesn't seem to work with it.
* For ruby/ruby-ci-imaage, bionic doesn't have Ruby 2.7. I tried using
ruby-build to build Ruby 2.7 from package, but the build on its CI
seems to somehow loop forever when I do that. So I gave it up for now.
We might want to wait until bionic becomes EOL.
Note:
* AppVeyor Visual Studio 2015 has Ruby <= 2.6.3
https://www.appveyor.com/docs/windows-images-software/#ruby
* GitHub Actions windows-2019 uses Ruby 2.5.9
https://github.com/actions/runner-images/blob/main/images/win/Windows2019-Readme.md
2023-03-10 23:40:22 -08:00
Takashi Kokubun
d5b7c8a972
RJIT: Always enable --rjit-dump-disasm
2023-03-10 11:29:25 -08:00
Takashi Kokubun
65f2563551
Explain the project purpose in rjit.md [ci skip]
2023-03-09 20:57:07 -08:00
Takashi Kokubun
4bf037bebd
Update documentation about RJIT
2023-03-07 23:31:39 -08:00
Takashi Kokubun
23ec248e48
s/mjit/rjit/
2023-03-06 23:44:01 -08:00
Takashi Kokubun
2e875549a9
s/MJIT/RJIT/
2023-03-06 23:44:01 -08:00
Takashi Kokubun
eaccdc1941
Rename MJIT filenames to RJIT
2023-03-06 23:44:01 -08:00
Takashi Kokubun
854546fcc4
MJIT is no longer slower on Rails
2023-03-06 23:24:05 -08:00
Ezra-Shimon Rosenfeld
ddd3c92bf6
[DOC] Add missing word to documentation_guide.md
2023-03-03 09:40:40 +09:00
BurdetteLamar
3b239d2480
Remove (newly unneeded) remarks about aliases
2023-02-19 14:26:34 -08:00
zverok
ce0f3de032
[DOC] Update pattern matching docs for 3.2
...
* Remove section about experimental status
* Add references to core objects that can deconstruct
2023-02-19 22:32:52 +02:00
Jeremy Evans
59f7bf96d6
Mention when it is appropriate to document aliases in call-seq
2023-02-19 11:58:00 -08:00
Burdette Lamar
ea50765926
[DOC] Change to handling of aliases ( #7340 )
...
Change to handling of aliases
2023-02-19 13:41:32 -06:00
Hiroshi SHIBATA
de7eb5e79a
clean_env of Bundler is deprecated. It's unbundled_env now
2023-02-18 14:49:21 +09:00
Kouhei Yanagita
619af4fd64
[DOC] Add an example of the splat operator with a non-array object ( #7098 )
2023-02-15 12:43:55 +09:00
Burdette Lamar
3c7d5ccdce
[ruby/net-http] [DOC] Enhanced RDoc for request headers
...
(https://github.com/ruby/net-http/pull/120 )
https://github.com/ruby/net-http/commit/b4eb8a7932
2023-02-14 20:33:11 +00:00
Takashi Kokubun
6517d1a188
[DOC] Move old ChangeLog files to doc/ChangeLog ( #7293 )
2023-02-10 16:57:56 -08:00
Takashi Kokubun
d8facbabff
[DOC] Make the header levels consistent again
2023-02-10 16:37:43 -08:00
Jeremy Evans
27fe4a1bc5
Fix minor issues in doc/maintainers.md ( #7292 )
...
Use *unmaintained* instead of Ruby core team in 2 places, for
consistency with the rest of the document.
Use h3 instead of h4 tags if nested directly under h2.
2023-02-10 16:37:07 -08:00
Takashi Kokubun
c06565390e
[DOC] debug.rb is a bundled gem from 3.1
2023-02-10 16:34:55 -08:00
Takashi Kokubun
0e7eac7b48
[DOC] Add a link to [ruby-core:25764]
2023-02-10 16:30:47 -08:00
Takashi Kokubun
f6d4f2bf67
Convert doc/maintainers.rdoc to .md ( #7291 )
...
* [DOC] Convert maintainers.rdoc to .md
with RDoc::Markup::ToMarkdown
* [DOC] Format maintainers.md
2023-02-10 16:21:34 -08:00
Aaron Patterson
b61edc5f5d
Add internals glossary
...
I started a glossary to help new contributors navigate the internals of
CRuby, and I think we should maintain it in ruby/ruby
2023-02-09 16:59:40 -08:00
Nobuyoshi Nakada
6aa196149a
[DOC] Refine/fix doc/contributing/building_ruby.md [ci skip]
...
* Separate dependencies for RubyGems
* Add reasons of optional libraries
* Add a note for gperf and fix the required version
2023-02-08 20:15:47 +09:00
Benoit Daloze
08c2094715
Fix confusing "
2023-02-07 20:30:47 +01:00
Benoit Daloze
779092508c
Add Building the Tarball section in distribution docs
2023-02-07 20:27:53 +01:00
Benoit Daloze
826067b0f9
Clarify section about getting the Ruby tarball
2023-02-07 20:22:14 +01:00
Hiroshi SHIBATA
31d37e2406
Mentioned gmp at requirements
2023-02-07 21:38:24 +09:00
Hiroshi SHIBATA
8623c81220
Document default gems and bundled gems specifications
2023-02-07 17:29:19 +09:00
Hiroshi SHIBATA
5ee39ea67f
Added tarball instruction to building_ruby.md
2023-02-07 14:21:18 +09:00
cjilbert504
a719e3418e
[ruby/rdoc] Remove duplicate word in RDoc::MarkupReference
...
The word "for" appeared twice in the same sentence in the margins section, and this PR removes the duplicate occurrence.
2023-02-06 23:09:38 +00:00
cjilbert504
8a474b344e
[ruby/rdoc] [DOC] Fix reference to proper list type RDoc::MarkupReference
...
The "Lettered List" section referred to the previous "Numbered List" section, so this PR fixes that reference to point instead of lettered lists.
2023-02-05 09:28:02 +00:00
BurdetteLamar
3e5a77f1ae
[ruby/net-http] Remarks on inclusions
...
https://github.com/ruby/net-http/commit/dfd060c583
2023-02-02 14:16:59 +00:00
Hiroshi SHIBATA
c35ebed895
Removed OS specific section because It's out of scope for us.
2023-02-02 18:11:06 +09:00