github
/
ruby
зеркало из https://github.com/github/ruby.git
1
0
Форкнуть 0
Код Задачи Пакеты Проекты Релизы Вики Активность
86 920 коммитов 219 Ветки 1 255 Теги 478 MiB
Граф коммитов

1391 Коммитов

Автор SHA1 Сообщение Дата
Hiroshi SHIBATA 3474a62033
Mentioned scoop and vcpkg for windows build instruction 2023-02-02 14:48:44 +09:00
Nobuyoshi Nakada f499c81b01 [DOC] Merge README.win32 to doc/windows.md 2023-02-02 11:22:16 +09:00
Maxime Chevalier-Boisvert 97740a525e
Update yjit.md 
Update some out of date information and mention how to check that YJIT is enabled.
 2023-01-31 15:53:40 -05:00
Maxime Chevalier-Boisvert c221a40201
Update yjit.md 2023-01-31 10:33:08 -05:00
Burdette Lamar d92289f633 [ruby/net-http] [DOC] Enhanced RDoc for Net::HTTP 
(https://github.com/ruby/net-http/pull/110)

https://github.com/ruby/net-http/commit/b098caa5e4
 2023-01-31 14:18:50 +00:00
Talal Al-Humaidi 93bb415516
[DOC] Change local method to local variable in assignment docs 2023-01-23 11:48:44 +09:00
Samuel Williams 3e7fdf2953
Windows build instructions documentation. (#6956) 
Windows build instructions.
 2023-01-22 00:13:16 +13:00
Samuel Williams 5cdf312d2c
Add `doc/distribution.md` to help reduce some of the confusion. (#6856) 2023-01-22 00:12:17 +13:00
Hiroshi SHIBATA 845f6275b2
OpenSSL, libyaml and zlib is always required to build. see test/test_extlibs.rb 2023-01-20 17:54:34 +09:00
Hiroshi SHIBATA 231b09f195
Added supported versions to OpenSSL and libyaml 2023-01-20 17:54:34 +09:00
Hiroshi SHIBATA 1edef08dda
Added version policy of BASERUBY 
[Misc #16671]
 2023-01-20 17:54:22 +09:00
Hiroshi SHIBATA 6aa9c84500
Separate dependencies section from quick start 2023-01-20 17:42:50 +09:00
Hiroshi SHIBATA ea10dea6c7
fixed wrong version of baseruby 2023-01-20 17:38:29 +09:00
Maxime Chevalier-Boisvert a9bcc058bb
Update yjit.md 2023-01-17 16:21:13 -05:00
Nobuyoshi Nakada a2748c500d
[DOC] Update `String#encode` special case 
This behavior has been slightly extended with the addition of
`String#scrub`.
 2023-01-16 19:44:40 +09:00
Martin Dürst 11f28f3268 [DOC] Explain that transcoding to the same encoding just copies. 
This is a reenstatement of the explanation in commit
463633e4a9 to partially
address Bug #19342.
 2023-01-16 16:30:15 +09:00
Nobuyoshi Nakada 468ce1488d [DOC] Use RDoc inclusions in transcode.c 2023-01-16 13:38:58 +09:00
Kazuhiro NISHIYAMA 391d431073
[DOC] Fix markup [ci skip] 2023-01-13 09:46:15 +09:00
Nobuyoshi Nakada a468213917 [DOC] Mention the conditional regexp 2023-01-11 23:25:28 +09:00
Maxime Chevalier-Boisvert 40bf89872f
Update yjit.md 
Add Alan Wu's keynote & Maxime's talk to the list of YJIT-related talks :)
 2023-01-09 14:12:10 -05:00
Nobuyoshi Nakada d9520bf2de [DOC] Mention `configure` options earlier, not after failure 
The command line arguments to `configure` are stored in `rbconfig.rb`.
Usually these are just useless but harmless after the installation,
however could affect unexpectedly when updating default gems.
 2023-01-06 20:00:53 +09:00
Nobuyoshi Nakada 42820a9807 [DOC] Specify `shell` format to shell commands 2023-01-06 20:00:53 +09:00
Kazuhiro NISHIYAMA bdd350453c
Fix typos [ci skip] 2023-01-06 17:53:00 +09:00
John Bampton f430701b1b
[DOC] remove space from inside code span element 2022-12-29 22:20:39 +09:00
Nobuyoshi Nakada bb60e4615f [DOC] Un-capitalize headings 2022-12-26 20:29:56 +09:00
Nobuyoshi Nakada cb820bff33 [DOC] Update extension.rdoc 
Refine the uses of word "Data", which were often ambiguous.  Also,
that word now refers the new class unrelated to `T_DATA`.
 2022-12-26 20:29:56 +09:00
Kazuhiro NISHIYAMA 7d264e8e7b
Copy NEWS.md to doc/NEWS/NEWS-3.2.0.md [ci skip] 2022-12-26 11:43:08 +09:00
Takashi Kokubun ad1ce2b7b6 Remove mjit.md from public documentation [ci skip] 
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-22 11:17:25 -08:00
Takashi Kokubun 1679ba61f8 Update MJIT documentation [ci skip] 2022-12-22 11:15:05 -08:00
Alan Wu bba2bfc975 [DOC] encodings.rdoc: universal_newline reacts to \r 
It wasn't clear that the mode also translates "\r" to "\n".
 2022-12-22 13:10:22 -05:00
Jean Boussier 88040063d0 Array#pack: document silent truncation 
Ref: [Feature #19245]

At the very least this behavior should be documented.
 2022-12-20 19:17:57 +01:00
Takashi Kokubun 8f081d4d0f
Syntax-highlight scripts in yjit.md [ci skip] 
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-19 14:55:49 -08:00
Takashi Kokubun 33aa06e3e6
Use a ruby-lang alias [ci skip] 2022-12-08 22:40:56 -08:00
Maxime Chevalier-Boisvert 30c76f4d0d
Update yjit.md 
Update citation, fix outdated and inaccurate information.
 2022-12-07 16:46:59 -05:00
Maxime Chevalier-Boisvert 8a74361b41
Update yjit.md to mention `RUBY_YJIT_ENABLE` 2022-11-28 16:45:42 -05:00
Maxime Chevalier-Boisvert c4e99ac454
Update yjit.md 2022-11-22 16:18:31 -05:00
Takashi Kokubun 607fb49dbc
YJIT: Lower the required Rust version from 1.58.1 to 1.58.0 (#6780) 2022-11-21 10:27:39 -08:00
BurdetteLamar 909ea6b60d [ruby/net-http] About the Examples moved to separate file 
https://github.com/ruby/net-http/commit/0512b5bfc9
 2022-11-19 15:33:28 +00:00
Maxime Chevalier-Boisvert a1b460bd6e
Update yjit.md 
Remove disclaimer
 2022-11-13 12:42:47 -05:00
yui-knk 5a4d9f91c4 Update required Bison version in building_ruby.md [ci skip] 
See [Feature #19068] for the context.
 2022-11-10 08:20:05 +09:00
Burdette Lamar 0e1e1b1980
[DOC] Enhanced RDoc for IO (#6669) 2022-11-09 10:15:39 -06:00
Matt Valentine-House aada904d94 [doc] Clarify how to build OpenSSL on macOS 2022-11-08 14:59:01 -05:00
Peter Zhu 7456647eff [DOC] Properly number the list in building_ruby.md 2022-11-07 19:47:12 -05:00
Peter Zhu b14f133054 [DOC] Improve building_ruby.md 2022-11-07 14:35:21 -05:00
Peter Zhu d24ac6d281 Update configure command in building_ruby.md 
Readers didn't realize that you can use --prefix with
--disable-install-doc.
 2022-11-03 16:58:39 -04:00
Sampat Badhe d9cf038859
Update Regexp.timeout doc (#6658) 
* Correct Regexp.timeout doc, Timeout.timeout= => Regexp.timeout=

* add link Regexp Timeout section
 2022-11-02 14:05:54 +09:00
Burdette Lamar 91c28ab2ee
[DOC] Enhanced RDOc for IO (#6642) 
In io.c treats:
    #close
    #close_read
    #close_write
    #closed
 2022-10-29 14:47:16 -05:00
Maxime Chevalier-Boisvert 2812a57b14
Update docs wrt YJIT limitations and building YJIT (#6641) 
* Update docs wrt YJIT limitations and building YJIT

* Update building_ruby.md

Fix relative link
 2022-10-27 16:50:00 -04:00
Burdette Lamar 841be6392e
[DOC] Revert previous merge (#6624) 
Revert previous merge
 2022-10-24 10:38:19 -05:00
Burdette Lamar bcb72f503c
[DOC] Add note about method names (#6620) 2022-10-24 08:56:13 -05:00
Thomas E. Enebo 420bdba139 [rubygems/rubygems] Allow upcoming JRuby to pass keywords for Kernel#warn 
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-22 08:01:24 +00:00
Burdette Lamar c7754a4d4c
[DOC] Add link targets (#6602) 2022-10-21 14:42:28 -05:00
Burdette Lamar bc939d2937
[DOC] More about line number (#6582) 2022-10-19 10:34:51 -05:00
Burdette Lamar d67b6310d3
[DOC] Link to packed data doc (#6567) 
* 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>
 2022-10-18 10:16:22 -05:00
Burdette Lamar 8d20632df8
[DOC] Packed data (#6520) 
New page for packed data
 2022-10-15 10:53:08 -05:00
Eileen M. Uchitelle 7e81dd9407
Update yjit docs (#6548) 
* The list of supported architectures was updated in
5ef048e5b1
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
 2022-10-14 09:43:18 -07:00
sampatbadhe 1fe2e34613 Fix a typo Denail-of-Service => Denial-of-Service [ci skip] 2022-10-08 12:36:05 +09:00
Burdette Lamar 7837dccb0e
Adapt doc guide to new GFM features (#6504) 
* Adapt doc guide to new GFM features

* Adapt doc guide to new GFM features
 2022-10-06 15:02:37 -05:00
Burdette Lamar 5fc68e1101
[DOC] Adding remarks about HTML and tables (#6485) 
* Adding remarks about HTML and tables
 2022-10-04 13:50:33 -05:00
Burdette Lamar 5d4048e0bc
[DOC] More on IO streams (#6454) 
Adds remarks about .new and .open.
Uses ..open where convenient (not convenient where output would be in a block).
Fixed examples for #ungetc.
 2022-09-27 13:58:28 -05:00
Burdette Lamar c35e924f64
[DOC] More on IO streams (#6445) 
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.
 2022-09-27 08:50:53 -05:00
Burdette Lamar 3ddab3a84e
[DOC] Housekeeping in iostreams doc (#6420) 
Write some method names in linkable form; make some capitalization consistent.
 2022-09-23 09:41:21 -05:00
Burdette Lamar 56d773dc6f
New page IO Streams (#6383) 
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.
 2022-09-21 16:34:55 -05:00
Akihiro Sada 02e25db68f Add URI.escape and URI.unescape to NEWS-3.0.0 [ci skip] 2022-09-21 17:35:22 +09:00
Takashi Kokubun 7cab7e5fde
Stop recommending duplicated options [ci skip] (#6400) 2022-09-19 15:13:53 +09:00
Nobuyoshi Nakada a8a7c9d05d
[DOC] [Bug #17120] Fix match-reset `\K` 2022-09-05 19:36:21 +09:00
Takashi Kokubun 915cbdb226
Stop testing MJIT on s390x 
It didn't work either.
http://rubyci.s3.amazonaws.com/s390x/ruby-master/log/20220905T080003Z.fail.html.gz
 2022-09-05 02:02:17 -07:00
Takashi Kokubun fb769aaa14
Update MJIT doc about bindgen and platforms [ci skip] 2022-09-05 01:30:50 -07:00
Nobuyoshi Nakada 0111dc5b79
[DOC] Escape backqoute method not to be converted to smart quotes 2022-09-03 23:47:46 +09:00
Takashi Kokubun ce70cb6469
It was a relative path [ci skip] 2022-08-31 17:18:22 -07:00
Takashi Kokubun a0d2320f30
Add a document about YJIT's Rust version 2022-08-31 17:16:29 -07:00
Burdette Lamar d41be1ac37
[DOC] Enhanced RDoc for Time (#6308) 
More on timezones.
 2022-08-31 16:36:22 -05:00
Takashi Kokubun 221a523683
Put a documentation about MJIT [ci skip] 2022-08-30 17:07:27 -07:00
Maxime Chevalier-Boisvert 5ef048e5b1 Update yjit.md 
Add VMIL paper, update supported CPUs.
 2022-08-29 09:09:41 -07:00
Burdette Lamar 8706b74b90
[DOC] Enhanced RDoc for Time (#6277) 
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
 2022-08-25 13:02:18 -05:00
Burdette Lamar aeac8b6c3a
[DOC] Addition to section 'Related Methods' (#6271) 
Addition to section 'Related Methods':  suggests adding differentiators to the names of related methods.
 2022-08-22 13:17:05 -05:00
Burdette Lamar b8d142e733
[DOC] Enhanced RDoc for Time (#6267) 
Treats:
    #utc
    #getlocal
    #getutc
    #ctime
    #to_s
    #inspect
 2022-08-22 11:21:36 -05:00
Nobuyoshi Nakada 148d0ccd18
[DOC] Fix a type [ci skip] 2022-08-22 23:15:30 +09:00
Nobuyoshi Nakada f99904341e
[DOC] Remove extra page-dir prefix 2022-08-22 23:15:30 +09:00
Burdette Lamar 936327a519
[DOC] Enhanced RDoc for Time (#6255) 
Treats:
    #utc
    #hash
    #localtime
 2022-08-21 11:36:36 -05:00
Nobuyoshi Nakada bd0fe26b81
[DOC] Fix "military timezone" 
Not only `J` is called military timezone.
 2022-08-19 10:20:52 +09:00
Peter Zhu 4e66b3f47b [ruby/rdoc] [DOC] Remove duplicated line in RDoc::MarkupReference 
https://github.com/ruby/rdoc/commit/488f89aee4
 2022-08-16 02:48:04 +09:00
Burdette Lamar fa65800ee5 [ruby/rdoc] [DOC] Enhances text about escapes (https://github.com/ruby/rdoc/pull/917) 
https://github.com/ruby/rdoc/commit/c40bac829c
 2022-08-13 09:00:18 +09:00
Burdette Lamar 5e3e4bc984 [ruby/rdoc] Mods to section Text Markup (https://github.com/ruby/rdoc/pull/916) 
https://github.com/ruby/rdoc/commit/5506d4d67e
 2022-08-12 05:09:02 +09:00
Burdette Lamar 8a3f401b24 [ruby/rdoc] Improvements to Text Markup examples (https://github.com/ruby/rdoc/pull/915) 
https://github.com/ruby/rdoc/commit/d00ddfe57c
 2022-08-12 01:43:43 +09:00
Burdette Lamar c361cf44c0 [ruby/rdoc] [DOC] Make example formats explicit and consistent (https://github.com/ruby/rdoc/pull/913) 
https://github.com/ruby/rdoc/commit/7e6ef6c855
 2022-08-11 22:51:09 +09:00
Burdette Lamar 9fc401b689 [ruby/rdoc] Treat text markup (italic, bold, monofont) as blocks (https://github.com/ruby/rdoc/pull/911) 
https://github.com/ruby/rdoc/commit/dc88f1b425
 2022-08-11 06:18:39 +09:00
Burdette Lamar 26bed71959
[DOC] Adding a few standards-based formats (#6227) 2022-08-10 13:40:50 -05:00
Takashi Kokubun f8936b3341
Remove documentation about dev 
dev is Shopify's internal tool that doesn't work if you use Intel
Homebrew on M1 (or rbenv, btw). Now that we maintain this outside
Shopify's repository, we should stop talking about it here.
 2022-08-08 19:02:30 -07:00
Nobuyoshi Nakada 289d219758 [ruby/date] [DOC] Fix about calendars difference 
https://github.com/ruby/date/commit/0ae93e26aa
 2022-08-08 21:14:10 +09:00
Burdette Lamar 1607c6d281 [DOC] New doc about Julian/Gregorian (#70) 2022-08-07 20:42:31 -04:00
Burdette Lamar 23a84d53c6 [ruby/rdoc] [DOC] Removes remaining old Markup Reference (https://github.com/ruby/rdoc/pull/910) 
https://github.com/ruby/rdoc/commit/4e44c9c6cf
 2022-08-07 21:07:23 +09:00
Peter Zhu da00243dfe [DOC] Specify ways to run bootstrap tests 2022-08-02 09:40:53 -04:00
Burdette Lamar f78e46d404 [ruby/rdoc] Add block quotes (https://github.com/ruby/rdoc/pull/907) 
Also adjusts which blocks may be nested.

https://github.com/ruby/rdoc/commit/dde1860441
 2022-07-29 23:40:26 +09:00
Burdette Lamar 18b1e5e6db [ruby/rdoc] [DOC] Add some links in intro; delimit rendered HTML output. (https://github.com/ruby/rdoc/pull/904) 
https://github.com/ruby/rdoc/commit/c02645364f
 2022-07-28 23:50:49 +09:00
Matt Valentine-House 70a9328b79 [ci-skip]Document how to run an individual bootstrap test 2022-07-27 09:16:04 -04:00
Burdette Lamar 64f9f7d855 [ruby/rdoc] [DOC] Clarifications for directives (https://github.com/ruby/rdoc/pull/903) 
-  Former section "Directives in Trailing Comments" is reworked. The important thing about a directive is what it does, not whether it's trailing or stand-alone. Therefore I've worked the directives in the former section into the appropriate sections, based on function.
- Each directive is now explicitly marked as trailing or stand-alone.
- C-code directives are mentioned only for those directives that actually appear in our ruby/ruby C files, which are :startdoc:, :stopdoc:, :enddoc:, :include:, and :call-seq:. What effect, if any, other directives have in C, I'm not sure about.

https://github.com/ruby/rdoc/commit/b00978bfa5
 2022-07-27 05:06:56 +09:00
Peter Zhu 33f9e8f4ea Add doc/rdoc directory to .document 
Adding the doc/rdoc directory to .document will allow files in that
directory to be included in the documentation.
 2022-07-26 12:31:47 -04:00
Burdette Lamar cc29b43c7a [ruby/rdoc] Move section Directives into section Blocks (https://github.com/ruby/rdoc/pull/901) 
https://github.com/ruby/rdoc/commit/e48e07ef53
 2022-07-26 06:31:36 +09:00
git d7868c79e2 * append newline at EOF. [ci skip] 2022-07-26 05:29:28 +09:00
Peter Zhu ba098fa151 Sync RDoc 2022-07-25 16:29:14 -04:00
Jeremy Evans 4813443837 Fix language describing protected methods 
Fixes [Bug #18887]
 2022-07-14 13:28:58 -07:00
Burdette Lamar e3a988a29c
[DOC] Revisions for call-seq in doc guidelines (#6121) 
Splits certain guidelines for singleton and instance method.
    Calls for instance method to not prefix anything (like RDoc itself for a Ruby-coded instance method); e.g.:
        count -> integer, not array.count,.
        <=> other -> integer or nil, not hash <=> other -> integer or nil.
    Groups previous guidelines into Arguments, Block, Return types, Aliases.
 2022-07-12 20:49:24 -05:00
Burdette Lamar 8f5ad74e40
[DOC] New page for strftime formats (#6074) 
This new page would be linked from method strftime in Time, Date, and DateTime, replacing the text there.
 2022-07-01 15:25:05 -05:00
John Hawthorn 962a3247b1 Correct documentation for protected methods [ci skip] 2022-06-23 13:50:26 -07:00
Hiroshi SHIBATA 15769832b2
Added readline wrapper entries under the doc directory 2022-06-21 20:43:42 +09:00
Hiroshi SHIBATA a9db5be0ca
Added error_highlight entries under the doc directory 2022-06-21 20:41:12 +09:00
Hiroshi SHIBATA 441cfa966c
Added reline entry to standard_library doc 2022-06-21 20:38:42 +09:00
Nobuyoshi Nakada 4a6facc2d6 [Feature #18788] [DOC] String options to `Regexp.new` 
Co-Authored-By: Janosch Müller <janosch.mueller@betterplace.org>
 2022-06-20 19:35:12 +09:00
Alexander Ilyin adcfd69690
[DOC] Fix markup for `String` (#5984) 
* Add missing space for `String#start_with?`.
* Add missing pluses for `String#tr` and
  `Methods for Converting to New String` label.
* Move quote into the tag for `Whitespace in Strings` label.
 2022-06-09 13:40:21 -05:00
Yusuke Endoh bda4d91f05 doc/case_mapping.rdoc: Fix references for case mapping 
The chart (https://www.unicode.org/charts/case) that is currently
referred seems to be wrong.

Also, use the "latest" redirect and add titles of the section and table.
[Bug #18590]
 2022-06-09 18:21:39 +09:00
Hiroshi SHIBATA f4173ff2fa
debug is the bundled gems, not default gems 2022-06-06 18:19:15 +09:00
Kazuhiro NISHIYAMA 5267829641
Fix a typo [ci skip] 2022-06-06 12:00:22 +09:00
Jemma Issroff 9241d75a61
Add information from doc/hacking.md and doc/make_cheatsheet.md back i… (#5963) 
Add information from doc/hacking.md and doc/make_cheatsheet.md back into contributing docs
 2022-05-30 23:50:39 -04:00
Samuel Williams bd472ef36f Show ASAN_OPTIONS in hacking guide. 2022-05-27 01:04:28 +12:00
Samuel Williams 946e3bbdc2 Simplify the autoload require logic. 2022-05-26 14:20:59 +12:00
Samuel Williams 42bcc629fb Retain reference to blocking fibers. 2022-05-25 15:24:24 +12:00
Samuel Williams 901525b107 Add support for address sanitizer for amd64 and arm64. 2022-05-25 15:24:24 +12:00
ydah 6c7e2617d1 [ruby/optparse] Fix typo in documentation 
- "hypnen" -> "hyphen"
- "hadler" -> "handler"

https://github.com/ruby/optparse/commit/e70e689ded
 2022-05-21 08:47:53 +09:00
Nobuyoshi Nakada 61a54d5180
[DOC] Re-markup as Markdown 2022-05-19 17:07:56 +09:00
Kaíque Kandy Koga c478a3c0a9
[DOC] Use `make gdb-ruby` and `make lldb-ruby` in doc/contributing/building_ruby.md 2022-05-18 11:32:13 +09:00
Alexey Mostovoy 9f9a0940dd Quick markup fix 2022-05-12 07:53:46 +09:00
Stan Lo 26a07b8b46 Add a separate doc for contributing to stdlibs [ci skip] 
co-authored-by: Peter Zhu <peter@peterzhu.ca>
 2022-05-11 15:13:01 -04:00
Jemma Issroff c00feffb46 Improve documentation on contributing to Ruby 
co-authored-by: Peter Zhu <peter@peterzhu.ca>
co-authored-by: Stan Lo <stan001212@gmail.com>
 2022-05-11 10:59:24 -04:00
Kazuhiro NISHIYAMA 2a6f79364a
Replace with https://github.com [ci skip] 2022-05-07 18:30:56 +09:00
Burdette Lamar ac75c710cc
Link from printf methods to format spec doc (#5886) 2022-05-05 09:01:12 -05:00
git 4f25971f05 * remove trailing spaces. [ci skip] 2022-05-05 05:05:04 +09:00
Burdette Lamar 197f9e9d42
[DOC] More on format specs (#5877) 
* Update doc/format_specifications.rdoc

Co-authored-by: Peter Zhu <peter@peterzhu.ca>
 2022-05-04 15:04:36 -05:00
Nobuyoshi Nakada 529c98ab90
[DOC] mention macros for public headers 2022-05-04 01:23:26 +09:00
Alan Wu b793245dac
[DOC] Some YJIT dependencies are no longer required 
The `capstone` crate on crates.io does not need `libcapstone` on the system
because it builds from [source].
`gdbm` is now a separate gem (thanks for extracting it!).

[source]: c31409905a/capstone-sys/build.rs (L143)
 2022-05-02 14:00:35 -04:00
Nobuyoshi Nakada 049303eff3
[DOC] Fix links to doc pages 2022-05-03 02:37:52 +09:00
Kazuhiro NISHIYAMA 2e901368ea
Fix a typo [ci skip] 2022-05-02 08:58:46 +09:00
Burdette Lamar fef79dfa25
Repair internal links (#5866) 
* Repair internal links

* Minor changes to format spec
 2022-05-01 12:26:42 -05:00
Burdette Lamar 7c039e423c
[DOC] Format specs (#5857) 
This new document would eventually replace the format spec discussion at Kernel#sprintf.
 2022-04-29 17:04:05 -05:00
Maxime Chevalier-Boisvert e1536a1e56
Update yjit.md 
Fix configure line in YJIT build instructions
 2022-04-27 13:16:42 -04:00
Alan Wu f90549cd38 Rust YJIT 
In December 2021, we opened an [issue] to solicit feedback regarding the
porting of the YJIT codebase from C99 to Rust. There were some
reservations, but this project was given the go ahead by Ruby core
developers and Matz. Since then, we have successfully completed the port
of YJIT to Rust.

The new Rust version of YJIT has reached parity with the C version, in
that it passes all the CRuby tests, is able to run all of the YJIT
benchmarks, and performs similarly to the C version (because it works
the same way and largely generates the same machine code). We've even
incorporated some design improvements, such as a more fine-grained
constant invalidation mechanism which we expect will make a big
difference in Ruby on Rails applications.

Because we want to be careful, YJIT is guarded behind a configure
option:

```shell
./configure --enable-yjit # Build YJIT in release mode
./configure --enable-yjit=dev # Build YJIT in dev/debug mode
```

By default, YJIT does not get compiled and cargo/rustc is not required.
If YJIT is built in dev mode, then `cargo` is used to fetch development
dependencies, but when building in release, `cargo` is not required,
only `rustc`. At the moment YJIT requires Rust 1.60.0 or newer.

The YJIT command-line options remain mostly unchanged, and more details
about the build process are documented in `doc/yjit/yjit.md`.

The CI tests have been updated and do not take any more resources than
before.

The development history of the Rust port is available at the following
commit for interested parties:
1fd9573d8b

Our hope is that Rust YJIT will be compiled and included as a part of
system packages and compiled binaries of the Ruby 3.2 release. We do not
anticipate any major problems as Rust is well supported on every
platform which YJIT supports, but to make sure that this process works
smoothly, we would like to reach out to those who take care of building
systems packages before the 3.2 release is shipped and resolve any
issues that may come up.

[issue]: https://bugs.ruby-lang.org/issues/18481

Co-authored-by: Maxime Chevalier-Boisvert <maximechevalierb@gmail.com>
Co-authored-by: Noah Gibbs <the.codefolio.guy@gmail.com>
Co-authored-by: Kevin Newton <kddnewton@gmail.com>
 2022-04-27 11:00:22 -04:00
Kazuhiro NISHIYAMA 0bab4c4add
[DOC] Change URLs from git.io 
see https://github.blog/changelog/2022-04-25-git-io-deprecation/
 2022-04-27 10:13:23 +09:00
Burdette Lamar 69c1145fa8
[DOC] Enhanced RDoc for Math module (#5837) 
Revises intro.
    Adds "What's Here".
    Revises methods doc.
 2022-04-25 10:07:21 -05:00
Nobuyoshi Nakada 5701b4084e
[DOC] mention assignment expression values 2022-04-25 23:50:49 +09:00
Burdette Lamar d41bc9b68e
More details for Rational literals (#5840) 2022-04-24 19:41:26 -05:00
Burdette Lamar b074bc3d61
[DOC] Enhanced RDoc for MatchData (#5819) 
Treats:
    #begin
    #end
    #match
    #match_length
 2022-04-18 13:02:35 -05:00
Burdette Lamar 9d1dd7a9ed
[DOC] Enhanced RDoc for MatchData (#5818) 
Treats:
    #regexp
    #names
    #size
    #offset
 2022-04-18 11:31:30 -05:00
Burdette Lamar 2b4b513ef0
[DOC] Enhanced RDoc for Regexp (#5812) 
Treats:

    #fixed_encoding?
    #hash
    #==
    #=~
    #match
    #match?

Also, in regexp.rdoc:

    Changes heading from 'Special Global Variables' to 'Regexp Global Variables'.
    Add tiny section 'Regexp Interpolation'.
 2022-04-16 15:20:03 -05:00
Burdette Lamar e021754db0
[DOC] Enhanced RDoc for Regexp (#5807) 
Treats:

    #source
    #inspect
    #to_s
    #casefold?
    #options
    #names
    #named_captures
 2022-04-15 13:31:15 -05:00
Peter Zhu da1695b926 [ruby/optparse] Fix broken links in docs 
https://github.com/ruby/optparse/commit/2bea3b38c3
 2022-04-15 14:21:28 +09:00
Burdette Lamar 01395d84ab
More details for regexp literals (#5800) 2022-04-14 14:25:06 -05:00
Burdette Lamar b21026cb1a
Enhanced RDoc for Symbol (#5795) 
Treats:

    #==
    #inspect
    #name
    #to_s
    #to_sym
    #to_proc
    #succ
    #<=>
    #casecmp
    #casecmp?
    #=~
    #match
    #match?
 2022-04-12 17:27:18 -05:00
Burdette Lamar 7d709ceb12
Specify which core classes are convertible (#5790) 2022-04-11 13:49:38 -05:00
Burdette Lamar 9ca3d537b9
All-in-one RDoc for class String (#5777) 2022-04-07 14:29:04 -05:00
Kazuhiro NISHIYAMA f2377e4caa
Fix a typo [ci skip] 2022-04-07 16:47:07 +09:00
Burdette Lamar 717b20ee30
[DOC] Enhanced RDoc for string slices (#5769) 
Creates file doc/string/slices.rdoc that the string slicing methods can link to.
 2022-04-06 15:47:22 -05:00
Burdette Lamar 4a4485adbd
Enhanced RDoc for String#index (#5759) 2022-04-04 14:18:10 -05:00
Burdette Lamar 0b0ae583f4
[DOC] Enhanced RDoc for String (#5753) 
Treats:
    #length
    #bytesize
 2022-04-03 10:09:34 -05:00
Nobuyoshi Nakada f801386f0c
[DOC] Describe append_{c,cpp,ld}flags 2022-04-03 13:38:31 +09:00
Burdette Lamar 7be4d900f0
[DOC] Enhanced RDoc for String (#5751) 
Adds to doc for String.new, also making it compliant with documentation_guide.rdoc.
    Fixes some broken links in io.c (that I failed to correct yesterday).
 2022-04-02 14:26:49 -05:00
Nobuyoshi Nakada 729b9a8543
[DOC] Fix broken links to encodings.rdoc 
Also prefers class name based references than file name based
references.
 2022-04-02 15:06:12 +09:00
Burdette Lamar 81741690a0
[DOC] Main doc for encodings moved from encoding.c to doc/encodings.rdoc (#5748) 
Main doc for encodings moved from encoding.c to doc/encodings.rdoc
 2022-04-01 20:41:04 -05:00
Burdette Lamar 056b7a8633
[DOC] Enhanced RDoc for String (#5742) 
Treats:
    #force_encoding
    #b
    #valid_encoding?
    #ascii_only?
    #scrub
    #scrub!
    #unicode_normalized?
Plus a couple of minor tweaks.
 2022-03-31 15:09:25 -05:00
Yusuke Endoh 34b288f8d4 doc/regexp.rdoc: Add explanation about Regexp timeout configuration 2022-03-30 16:50:46 +09:00
Burdette Lamar b257034ae5
[DOC] Enhanced RDoc for String (#5730) 
Treats:

    #start_with?
    #end_with?
    #delete_prefix
    #delete_prefix!
    #delete_suffix
    #delete_suffix!
 2022-03-29 09:54:29 -05:00
Burdette Lamar 5525e47a0b
[DOC] Enhanced RDoc for String (#5726) 
Treats:

    #ljust
    #rjust
    #center
    #partition
    #rpartition
 2022-03-28 15:49:18 -05:00
Burdette Lamar d52cf1013f
[DOC] Enhanced RDoc for String (#5724) 
Treats:

    #scan
    #hex
    #oct
    #crypt
    #ord
    #sum
 2022-03-27 14:45:14 -05:00
Burdette Lamar 465edb96f0
[DOC] Enhanced RDoc for String (#5707) 
Treated:

    #chomp
    #chomp!
    #chop
    #chop!
 2022-03-24 19:40:58 -05:00
Nobuyoshi Nakada e6c1db1d8a
[DOC] Refine flip-flop 2022-03-24 19:08:43 +09:00
Yusuke Endoh 8dc357fa94 Add Yuta Saito (katei) as the platform maintainer of WebAssembly/WASI 2022-03-24 13:23:24 +09:00
Burdette Lamar 0140e6c41e
[DOC] Enhanced RDoc for String (#5685) 
Treats:

    #chars
    #codepoints
    #each_char
    #each_codepoint
    #each_grapheme_cluster
    #grapheme_clusters

Also, corrects a passage in #unicode_normalize that mentioned module UnicodeNormalize, whose doc (:nodoc:, actually) says not to mention it.
 2022-03-22 14:51:05 -05:00
Nobuyoshi Nakada 414ad77142
[DOC] re-count test suites run by `make check` [ci skip] 2022-03-22 11:24:53 +09:00
Burdette Lamar c129b6119d
[DOC] Use RDoc inclusions in string.c (#5683) 
As @peterzhu2118 and @duerst have pointed out, putting string method's RDoc into doc/ (which allows non-ASCII in examples) makes the "click to toggle source" feature not work for that method.

This PR moves the primary method doc back into string.c, then includes RDoc from doc/string/*.rdoc, and also removes doc/string.rdoc.

The affected methods are:

    ::new
    #bytes
    #each_byte
    #each_line
    #split

The call-seq is in string.c because it works there; it did not work when the call-seq is in doc/string/*.rdoc.

This PR also updates the relevant guidance in doc/documentation_guide.rdoc.
 2022-03-21 14:58:00 -05:00
Nobuyoshi Nakada 9f82818833
[DOC] Move old NEWS files to a separate directory 2022-03-22 01:37:34 +09:00
Burdette Lamar d52f41b765
[DOC] Enhanced RDoc for String (#5675) 
Treats:
    #split
    #each_line
    #lines
    #each_byte
    #bytes
 2022-03-18 17:17:00 -05:00
Burdette Lamar 59a1a8185f
[DOC] Enhanced RDoc for String#split (#5644) 
* Enhanced RDoc for String#split

* Enhanced RDoc for String#split

* Enhanced RDoc for String#split

* Enhanced RDoc for String#split

* Enhanced RDoc for String#split
 2022-03-16 14:45:48 -05:00
Nobuyoshi Nakada b426de9e8e
[DOC] Prefer local rdoc links 
- ensures exact same version
- avoid generated URLs
- no external access
- concise
 2022-03-16 19:12:34 +09:00
Burdette Lamar 09186f381f
Adding guidance about characters in C-code doc (#5641) 
Showing how to do as @nobu does -- putting doc into doc/*.rdoc instead of in *.c.
 2022-03-11 10:46:47 -06:00
Burdette Lamar 561dda9934
[DOC] Enhanced RDoc for String (#5635) 
Treats:

    #count
    #delete
    #delete!
    #squeeze
    #squeeze!

Adds section "Multiple Character Selectors" to doc/character_selectors.rdoc.

Co-authored-by: Peter Zhu <peter@peterzhu.ca>
 2022-03-09 19:53:51 -06:00
Kazuhiro NISHIYAMA ee5bf4cac2
[DOC] Remove an unnecessary character [ci skip] 2022-03-10 10:45:28 +09:00
Burdette Lamar 72c038a8f5
[DOC] Enhanced RDoc for String (#5633) 
Treats:

    #tr (revised to link to "Character Selectors" document)
    #tr!
    #tr_s
    #tr_s!

Also renames doc/character_selector.rdoc to match its title.
 2022-03-09 08:42:12 -06:00
Burdette Lamar 1d35630060
[DOC] RDoc for character selectors (#5632) 
This file will be a link target for methods doc that cites character selectors (e.g., String#tr),

It covers only the character selector; +replacement+ is discussed at String#tr (which will be revised and simplified); multiple selectors will be discussed at String#delete and String#count.

Co-authored-by: Peter Zhu <peter@peterzhu.ca>
 2022-03-08 16:27:36 -06:00
Burdette Lamar 1dd2d2ce48
[DOC] Change to guidance on lists in What's Here section (#5618) 
Currently, the guide says a "What's Here" section should have a labeled list for the methods. Such a list can render very differently in different browsers, and are often erratic in their indentation of continuation lines.
 2022-03-07 05:04:16 -06:00
Kazuhiro NISHIYAMA d62786279a
Mention removed gems since 3.1 [ci skip] 2022-03-05 21:05:52 +09:00
Kazuhiro NISHIYAMA fb928f0ea0
Fix typos [ci skip] 2022-03-04 11:28:25 +09:00
Nobuyoshi Nakada 5ef9f7a821
[DOC] Rename doc/*.rb as doc/*.rdoc 
With `:markup: ruby` directive so that they are parsed as ruby
scripts.
 2022-03-03 13:37:37 +09:00
Burdette Lamar b3123191c6
[DOC] Addition to encoding.rdoc (#5617) 
Adds section "Transcoding a Stream," listing relevant methods in IO.
    Moves an example from section "String Encoding Example" to the new section.
    Removes header "String Encoding Example" for now-empty section.
    Changes items in section "Transcoding a String" from labeled list items to bullet list items. (Labeled list items are sometimes rendered with strange indentations for continued lines, and are always rendered with different indentations for the items.)
 2022-03-02 14:26:20 -06:00
Burdette Lamar 7a6ba30c24
[DOC] Add encoding external/internal example to encoding.rdoc (#5610) 
* Add encoding external/internal example to encoding.rdoc

* Add encoding external/internal example to encoding.rdoc

* Update doc/encoding.rdoc

I think there may be some more of these that I've recently put into io.c.  Will check tomorrow and create new PR if so.

Co-authored-by: Peter Zhu <peter@peterzhu.ca>

Co-authored-by: Peter Zhu <peter@peterzhu.ca>
 2022-03-01 10:45:18 -06:00
Burdette Lamar 28ee1ca748
[DOC] Enhanced RDoc for encoding (#5603) 
Additions and corrections for external/internal encodings.
 2022-02-27 15:43:23 -06:00
Burdette Lamar 289a4cf672
[DOC] Extend intro/defn of 'transcoding' (#5602) 
* Extend intro/defn of 'transcoding'
 2022-02-27 06:44:58 -06:00
Nobuyoshi Nakada 3e5d7e3176
[DOC] Move String.new to allow non US-ASCII characters 2022-02-26 21:50:46 +09:00
Nobuyoshi Nakada 0be2049a89
[DOC] Fix the pseudo code 2022-02-26 16:34:10 +09:00
Nobuyoshi Nakada 62c1583353
[DOC] Place a non-US-ASCII document in a document-specific script 2022-02-26 16:23:04 +09:00
Burdette Lamar c19a631c99
[DOC] Enhancements for encoding.rdoc (#5578) 
Adds sections:

    String Encoding
    Symbol and Regexp Encodings
    Filesystem Encoding
    Locale Encoding
    IO Encodings
        External Encoding
        Internal Encoding
    Script Encoding
    Transcoding
        Transcoding a String
 2022-02-24 14:10:49 -06:00
Adrien S fc7e42a473
Fix yjit readme link pointing to old shopify readme (#5596) 2022-02-24 14:12:17 -05:00
Burdette Lamar 883fe55c4b
New doc about encoding (#5572) 
This is the beginning of an extended explication of Ruby encoding.

One of its more important jobs is to provide link targets for encoding documentation in other classes (String, File, IO, etc.). In particular, they can link to the "Encoding Options" section.

I'll have much to add to this document going forward, along with suitable adjustments in the class documentation.
 2022-02-18 13:33:18 -06:00
Burdette Lamar e9a2b30744
Enhanced RDoc concerning command injection (#5537) 
Clarifies security vulnerabilities for commands.

Treats:

    Kernel.system
    Kernel.` (backtick)
    IO.popen
    IO.read
    IO.write
    IO.binread
    IO.binwrite
    IO.readlines
    IO.foreach
 2022-02-18 06:46:04 -06:00
Nobuyoshi Nakada adca6f24b1
[DOC] Prefer the original file names over generated names 
Should also the label in an explicit `rdoc-ref:` link be converted
in the future?
 2022-02-09 15:31:10 +09:00
Max Leopold 203b1fc7e2 Add documentation for regexp emoji named character property 2022-02-04 08:26:49 +09:00
Kazuhiro NISHIYAMA aff4b2194f
Fix a typo [ci skip] 2022-02-02 09:08:12 +09:00
Steven Nunez b01657c470
[DOC] Fix case for new sentence. 2022-01-31 07:59:10 +09:00
manga_osyo 8d378fd28b Add Enumerable::Lazy#with_index to NEWS-2.7.0 
The behavior of `Enumerable::Lazy#with_index` has changed in Ruby 2.7.
This change was not listed in the Ruby 2.7 news, so I added it.
 2022-01-15 09:09:12 +09:00
Nobuyoshi Nakada 92630e2346
[ruby/optparse] Fix links to the page directory files [Bug #18468] 
https://github.com/ruby/optparse/commit/dab72c543d
 2022-01-12 21:16:02 +09:00
Nobuyoshi Nakada 39bebd762d
[ruby/optparse] Add .document files 
https://github.com/ruby/optparse/commit/ed283559d4
 2022-01-12 21:16:01 +09:00
Noah Gibbs 14967347b9
YJIT stats documentation additions and updates (#5427) 
* YJIT documentation additions and updates

* Update yjit.md

Co-authored-by: Maxime Chevalier-Boisvert <maximechevalierb@gmail.com>
 2022-01-11 14:17:59 -05:00
Alan Wu 04d9b6d2f9 [DOC] Link to Ruby Spec and rephrase project goal 
The word "specification" can be confusing as it might make readers
assume that the Ruby Spec Suite is a specification similar to an ISO
specification. Avoid the word and link to the project so curious parties
could read more about the project.
 2022-01-10 18:02:00 +01:00
Benoit Daloze ca97001a94 Make the Ractor-safe section more fluent 2022-01-10 13:08:59 +01:00
Trey Evans b4d0d07e2c Clarify ractor documentation meaning and formatting. 2022-01-10 13:04:31 +01:00
Nobuyoshi Nakada 65a8d52212
Revert "[DOC] Mention RBOOL in extension.rdoc [Feature #13125]" 
This reverts commit 9ad34da47f, as
`RBOOL` is not defined publicly yet.
 2022-01-09 19:17:48 +09:00
Nobuyoshi Nakada b43ad6b802
[DOC] Fold too long lines 2022-01-09 13:21:52 +09:00
Nobuyoshi Nakada 83983bacbc
[DOC] Mention `make check` 2022-01-09 12:40:25 +09:00
Nobuyoshi Nakada cc01ae591b
[DOC] test-spec would be preferable now 2022-01-09 12:34:11 +09:00
Samuel Williams 8648457541
Don't combine test-all and rubyspec. 2022-01-09 12:06:20 +13:00
Jeremy Evans f53dfab95c Add support for anonymous rest and keyword rest argument forwarding 
This allows for the following syntax:

```ruby
def foo(*)
  bar(*)
end
def baz(**)
  quux(**)
end
```

This is a natural addition after the introduction of anonymous
block forwarding.  Anonymous rest and keyword rest arguments were
already supported in method parameters, this just allows them to
be used as arguments to other methods.  The same advantages of
anonymous block forwarding apply to rest and keyword rest argument
forwarding.

This has some minor changes to #parameters output.  Now, instead
of `[:rest], [:keyrest]`, you get `[:rest, :*], [:keyrest, :**]`.
These were already used for `...` forwarding, so I think it makes
it more consistent to include them in other cases.  If we want to
use `[:rest], [:keyrest]` in both cases, that is also possible.

I don't think the previous behavior of `[:rest], [:keyrest]` in
the non-... case and `[:rest, :*], [:keyrest, :**]` in the ...
case makes sense, but if we did want that behavior, we'll have to
make more substantial changes, such as using a different ID in the
... forwarding case.

Implements [Feature #18351]
 2021-12-30 14:37:42 -08:00
Kazuhiro NISHIYAMA f445eccfb4
Expand URL to its canonical form [ci skip] 2021-12-28 10:23:46 +09:00
Kazuhiro NISHIYAMA 53b3c044fc
Copy NEWS.md to doc/NEWS-3.1.0.md and update for 3.2.0 2021-12-25 23:11:43 +09:00
Victor Shepelev a0f10a973f
[DOC] Add documentation for hash value omission syntax 2021-12-20 01:09:52 +09:00
Samuel Williams 78c175280b Fix code formatting. 2021-12-18 23:10:42 +13:00
Samuel Williams 1560cc1688 Introduce setup instructions for better parallelism. 2021-12-18 23:10:42 +13:00
Samuel Williams 75b5a4808f Initial hacking guide. 2021-12-18 19:15:11 +13:00
Burdette Lamar f7e266e6d2
Enhanced RDoc for case mapping (#5245) 
Adds file doc/case_mapping.rdoc, which describes case mapping and provides a link target that methods doc can link to.

Revises:

    String#capitalize
    String#capitalize!
    String#casecmp
    String#casecmp?
    String#downcase
    String#downcase!
    String#swapcase
    String#swapcase!
    String#upcase
    String#upcase!
    Symbol#capitalize
    Symbol#casecmp
    Symbol#casecmp?
    Symbol#downcase
    Symbol#swapcase
    Symbol#upcase
 2021-12-17 06:05:31 -06:00
Lars Kanis fff058a8d6 Add description of ruby header files to extension.rdoc 2021-12-16 20:10:55 +09:00
Nobuyoshi Nakada 9ad34da47f
[DOC] Mention RBOOL in extension.rdoc [Feature #13125] 2021-12-13 13:21:53 +09:00
Alan Wu 74159f7f3e
[DOC] Stop mentioning Qfalse==0 for C extensions 
See [Feature #18397] for detail. Follow up for
b859397e1b.

[ci skip]

Co-authored-by: Koichi Sasada <ko1@atdot.net>
 2021-12-09 13:38:20 -05:00
Jemma Issroff b859397e1b
[DOC] Stop recommending Qfalse==0 assumption to C extensions 
Encourage use of RTEST(), direct Qfalse comparison, and remove references to
Qfalse == 0 in extension documentation.

See [Bug #18397] for detail.
[ci skip]
 2021-12-09 11:23:51 -05:00
aycabta fa806cf233 Fix typo of namespace 2021-12-09 18:15:52 +09:00
Akihiro Sada c5f68a9a24
Fix typo in NEWS-2.5.0 [ci skip] 2021-12-09 12:28:42 +09:00
Burdette Lamar 0209beaca6
Enhanced RDoc for literals.rdoc (#5213) 
Makes link targets among percent literals.
    Adds links to those targets.
    Adds examples to percent literals.
    Links from opening summary list to corresponding sections.
 2021-12-06 16:26:28 -06:00
Burdette Lamar 28fb6d6b9e
Adding links to literals and Kernel (#5192) 
* Adding links to literals and Kernel
 2021-12-03 07:12:28 -06:00
Burdette Lamar eac7c63538
Enhanced RDoc for numeric.c (#5184) 
Adds remarks about literals and Kernel methods to Float and Integer.
 2021-11-27 13:07:37 -06:00
Adam Hess 8bde66167f
update YJIT docs to reference RubyVM::YJIT instead of just YJIT 
[ci skip]
 2021-11-24 20:23:22 -05:00
furunkel 1dcfcb6bc5 Fix typo 2021-11-24 23:06:28 +09:00
Jeremy Evans 4adb012926 Anonymous block forwarding allows a method to forward a passed 
block to another method without having to provide a name for the
block parameter.

Implements [Feature #11256]

Co-authored-by: Yusuke Endoh mame@ruby-lang.org
Co-authored-by: Nobuyoshi Nakada nobu@ruby-lang.org
 2021-11-18 14:17:57 -08:00
Maxime Chevalier-Boisvert cdebf57ec6
Add --yjit-no-type-prop so we can test YJIT without type propagation (#5135) 
* Add --yjit-no-type-prop so we can test YJIT without type propagation

* Fix typo in command line option

* Leave just two test workflows enable for YJIT
 2021-11-18 10:44:31 -05:00
Samuel Williams 81d0ce7e97 Mark IO::Buffer as experimental. 2021-11-10 19:21:05 +13:00
Samuel Williams 4b89034218 IO::Buffer for scheduler interface. 2021-11-10 19:21:05 +13:00
Kazuhiro NISHIYAMA ac642df228
Revert "Fix typo in ChangeLog-2.0.0 [ci skip]" 
This reverts commit e5792e7d55.

Because this is correct ChangeLog of
89fef02f13
and reverted commit makes inconsistency with
171c708b0c
 2021-11-07 13:13:32 +09:00
180909 e5792e7d55
Fix typo in ChangeLog-2.0.0 [ci skip] 2021-11-06 10:46:09 +09:00
Kazuhiro NISHIYAMA a53aab1273
Fix typos [ci skip] 2021-11-04 12:58:09 +09:00
180909 ee9f7fc2f7 fix typo in ChangeLog-1.9.3 2021-11-04 12:08:12 +09:00
Nobuyoshi Nakada e0915ba679
Fix typos in ChangeLog files [ci skip] 2021-11-02 19:17:37 +09:00
Peter Leitzen 09bdb43567 Clarify docs about magic comments placement 
Magic comments like `frozen_string_literal` may appear everywhere
within the first comment section while `encoding` have to be the first
line, or second line after shebang.
 2021-10-30 09:59:59 +09:00
Steven Nunez f180fa6ca3 Fix Typo 2021-10-26 13:10:49 -04:00
Koichi Sasada df9fac5ccd update doc/ractor.md about ivars 2021-10-23 01:32:55 +09:00
Nobuyoshi Nakada 4d4bdcf368
Move the test file 2021-10-21 13:07:48 +09:00
Maxime Chevalier-Boisvert 2e2430564a Update yjit.md 2021-10-20 18:19:43 -04:00
Alan Wu adcee68aa0 Doc: remove outdated note about hooking into the interpreter 
DAE remember MicroJIT?
 2021-10-20 18:19:43 -04:00
Alan Wu 8a9a2d0049 Move test_yjit_asm.sh into misc 
Since conventionally scripts don't live at the top level of the repo.
 2021-10-20 18:19:43 -04:00
Maxime Chevalier-Boisvert d11ea2520e Update yjit.md 2021-10-20 18:19:43 -04:00
Noah Gibbs 3dd4abfcd0 Move YJIT's README into doc/yjit/yjit.md 2021-10-20 18:19:42 -04:00
Noah Gibbs 6392702375 Incorporate feedback from the PR into yjit_hacking.md 2021-10-20 18:19:42 -04:00
Noah Gibbs d4a75dd976 Add a YJIT hacking doc with some internals; change the README text a bit to reflect its current condition 2021-10-20 18:19:42 -04:00
Maxime Chevalier-Boisvert 10217d147c Rename YJIT readme to README.md 2021-10-20 18:19:34 -04:00
Maxime Chevalier-Boisvert 04243533fc Update yjit.md 2021-10-20 18:19:33 -04:00
Maxime Chevalier-Boisvert 98e93d6a8f Update yjit.md 2021-10-20 18:19:32 -04:00
Marc Feeley aba4047955 Update yjit.md 
Fix a typo in the bibtex.
 2021-10-20 18:19:32 -04:00
Maxime Chevalier-Boisvert 4ccfbfe6fa Update yjit.md 2021-10-20 18:19:31 -04:00
Maxime Chevalier-Boisvert 46874b8fb9 Update yjit.md 2021-10-20 18:19:31 -04:00
Maxime Chevalier-Boisvert c56243dab4 Update yjit.md 2021-10-20 18:19:31 -04:00
Maxime Chevalier-Boisvert 4a99990b36 Update yjit.md 2021-10-20 18:19:31 -04:00
Maxime Chevalier-Boisvert e4e453c7d0 Update yjit.md 2021-10-20 18:19:31 -04:00
Maxime Chevalier-Boisvert 7b38bf189e Update yjit.md 2021-10-20 18:19:31 -04:00
Maxime Chevalier-Boisvert f2b170b01d Update and rename ujit.md to yjit.md 2021-10-20 18:19:30 -04:00
Maxime Chevalier-Boisvert 5c497dfd7f Update ujit.md 2021-10-20 18:19:30 -04:00
Maxime Chevalier-Boisvert 831ac473fa Update ujit.md 2021-10-20 18:19:30 -04:00
Maxime Chevalier-Boisvert 6f437d5b30 Update ujit.md 2021-10-20 18:19:30 -04:00
Maxime Chevalier-Boisvert 0888d9c9d5 Update ujit.md 2021-10-20 18:19:30 -04:00
Maxime Chevalier-Boisvert 8e5222c887 Update ujit.md 2021-10-20 18:19:30 -04:00
Maxime Chevalier-Boisvert 028e017e95 Update ujit.md 2021-10-20 18:19:30 -04:00
Maxime Chevalier-Boisvert 47900e10e3 Update ujit.md 2021-10-20 18:19:30 -04:00
Maxime Chevalier-Boisvert 6100b52ecf Update ujit.md 2021-10-20 18:19:30 -04:00
Maxime Chevalier-Boisvert 9d62ab303c Update ujit.md 2021-10-20 18:19:30 -04:00
Maxime Chevalier-Boisvert 7fbbd0c67c Update ujit.md 2021-10-20 18:19:29 -04:00
Maxime Chevalier-Boisvert 2babfeb858 Update ujit.md 2021-10-20 18:19:29 -04:00
Maxime Chevalier-Boisvert 701a802a42 Create ujit.md 2021-10-20 18:19:29 -04:00
mitsu-ksgr 2962c421e1
[DOC] fix small mistake in doc/marshal.rdoc [ci skip] 2021-10-03 11:09:08 +09:00
U.Nakamura 6bca410ae8 Move platform maintainers list 2021-09-28 15:50:38 +09:00
aycabta 00cfafc0f5 [ruby/irb] Add doc about "echo on assignment" 
https://github.com/ruby/irb/commit/5af637b3c1
 2021-09-27 03:23:48 +09:00
Nobuyoshi Nakada a27c274f04
[DOC] Fix broken links [ci skip] 
* As the "doc/" prefix is specified by the `--page-dir` option,
  remove from the rdoc references.
* Refer to the original .rdoc instead of the converted .html.
 2021-09-15 14:16:14 +09:00
Burdette Lamar 1af5a0c574
Bsearch doc for Array and Range (#4838) 
This PR creates doc/bsearch.rdoc to provide common documentation for bsearch in Array and Range.
 2021-09-14 16:08:21 -05:00
Kazuhiro NISHIYAMA 6f35a4e526
Use `./autogen.sh` instead of `autoconf` in doc 2021-09-11 12:29:59 +09:00
Koichi Sasada 3d4207f9bb
Need `#` 
`shareable_constant_value` is magic comment.
 2021-09-10 13:51:50 +09:00
Kenta Murata f8bb2d9b27
memory_view.c: Rename private to private_data for C++ (#4812) 
* memory_view.c: Rename private to private_data for C++

* doc/memory_view.md: Update document

* Fix doc/memory_view.md

Co-authored-by: Sutou Kouhei <kou@cozmixng.org>

Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
 2021-09-06 16:01:52 +09:00
aycabta ece4ed0da7 Add --autocomplete / --noautocomplete options 2021-08-30 02:45:13 +09:00
Nobuyoshi Nakada f51a6ace06
[DOC] prefer RUBY_DEFAULT_FREE to a magic number [ci skip] 2021-08-21 16:50:51 +09:00
Nobuyoshi Nakada 8f755ad6c8
[DOC] mention rb_define_alloc_func [ci skip] 2021-08-21 16:48:13 +09:00
Nobuyoshi Nakada 5e7cc0eebe
[DOC] update extension.ja.rdoc [ci skip] 
`rb_cData` has been deprecated for years.
 2021-08-21 11:21:37 +09:00
Kazuki Tsujimoto ecb6d6a4ef
Allow omission of parentheses in one line pattern matching [Feature #16182] 2021-08-19 17:07:58 +09:00
Hiroshi SHIBATA 23ef326656
Manually picking https://github.com/ruby/optparse/pull/14 2021-07-28 20:13:39 +09:00
Olle Jonsson 3026ee56b1
[ruby/optparse] Remove an errant { character (https://github.com/ruby/optparse/pull/26) 
https://github.com/ruby/optparse/commit/47417f1b4c
 2021-07-28 20:13:39 +09:00
Burdette Lamar c4556a2022
[ruby/optparse] Fix link in included file 
https://github.com/ruby/optparse/commit/bf03038d95
 2021-07-28 20:13:39 +09:00
Burdette Lamar 1333620afd
[ruby/optparse] More on tutorial (https://github.com/ruby/optparse/pull/24) 
- Adds section "Parsing" to tutorial.rdoc.
- Removes section "Terminators" from option_params.rdoc. (Terminator '--' is not an option parameter.)

https://github.com/ruby/optparse/commit/40d51ccbad
 2021-07-28 20:13:39 +09:00
Burdette Lamar 27679b349e
[ruby/optparse] More on tutorial (https://github.com/ruby/optparse/pull/23) 
- Removed a largish block of repeated text.
- Added sections "Top List and Base List" and "Methods for Defining Options" (on, define, etc.).
- Linked from class OptionParser doc to the tutorial.

https://github.com/ruby/optparse/commit/7f3195b9db
 2021-07-28 20:13:39 +09:00
Nobuyoshi Nakada a10db32003
[ruby/optparse] Removed a duplicate section 
https://github.com/ruby/optparse/commit/7ef3d89e78
 2021-07-28 20:13:39 +09:00
Burdette Lamar 98ccb49ac3
[ruby/optparse] More on tutorial (https://github.com/ruby/optparse/pull/22) 
Adds argument abbreviation in option_params.rdoc.
    Adds entire Argument Values section to tutorial.rdoc.

https://github.com/ruby/optparse/commit/9c5b3f244b
 2021-07-28 20:13:39 +09:00
Burdette Lamar 43af561e08
[ruby/optparse] Rdoc for help (https://github.com/ruby/optparse/pull/21) 
https://github.com/ruby/optparse/commit/d07cb96a96
 2021-07-28 20:13:39 +09:00
Burdette Lamar a15f0b9fe2
[ruby/optparse] Tutorial: explain custom argument converters (https://github.com/ruby/optparse/pull/19) 
https://github.com/ruby/optparse/commit/385dd4322d
 2021-07-28 20:13:39 +09:00
Nobuyoshi Nakada 311eb328c8
[ruby/optparse] Fixed mismatched <tt> tag 
https://github.com/ruby/optparse/commit/7e65ef3cfa
 2021-07-28 20:13:38 +09:00
Burdette Lamar a4631a4273
[ruby/optparse] Enhanced doc for option parameters (https://github.com/ruby/optparse/pull/11) 
https://github.com/ruby/optparse/commit/5618eeb49e
 2021-07-28 20:13:38 +09:00
Burdette Lamar 05e9efa323
[ruby/optparse] More on tutorial (https://github.com/ruby/optparse/pull/9) 
* More on tutorial

* More on tutorial

* More on tutorial

* More on tutorial: clearer example output

https://github.com/ruby/optparse/commit/84dfd92d2a
 2021-07-28 20:13:38 +09:00
BurdetteLamar 8844eba488
[ruby/optparse] Beginnings of tutorial 
https://github.com/ruby/optparse/commit/f209276f79
 2021-07-28 20:13:38 +09:00
Jeremy Evans 4fc9ddd7b6 Update Capturing and Anchors sections of regexp documention 
Document that only first 9 numbered capture groups can use the \n
backreference syntax.  Document \0 backreference.  Document \K anchor.

Fixes [Bug #14500]
 2021-07-27 12:30:43 -07:00
Ulysses Zhan e4b68ab700
[DOC] Fixed the description of regexp alternations [ci skip] 2021-07-22 14:10:57 +09:00
Burdette Lamar a541fe1a75
Doc guide for class/module (#4600) 
Co-authored-by: Marivaldo Cavalheiro <marivaldo@gmail.com>
 2021-07-18 18:43:34 -04:00
Kazuki Tsujimoto eed5e8f796
One-line pattern matching is no longer experimental 
https://github.com/ruby/dev-meeting-log/blob/master/DevelopersMeeting20210715Japan.md#feature-17724-make-the-pin-operator-support-instanceclassglobal-variables-jeremyevans0
 2021-07-17 11:13:52 +09:00