Граф коммитов

1229 Коммитов

Автор SHA1 Сообщение Дата
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