summaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2022-06-23Correct documentation for protected methods [ci skip]John Hawthorn
2022-06-21Added readline wrapper entries under the doc directoryHiroshi SHIBATA
2022-06-21Added error_highlight entries under the doc directoryHiroshi SHIBATA
2022-06-21Added reline entry to standard_library docHiroshi SHIBATA
2022-06-20[Feature #18788] [DOC] String options to `Regexp.new`Nobuyoshi Nakada
Co-Authored-By: Janosch Müller <janosch.mueller@betterplace.org> Notes: Merged: https://github.com/ruby/ruby/pull/6039
2022-06-09[DOC] Fix markup for `String` (#5984)Alexander Ilyin
* 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. Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-06-09doc/case_mapping.rdoc: Fix references for case mappingYusuke Endoh
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] Notes: Merged: https://github.com/ruby/ruby/pull/5607
2022-06-06debug is the bundled gems, not default gemsHiroshi SHIBATA
2022-06-06Fix a typo [ci skip]Kazuhiro NISHIYAMA
2022-05-30Add information from doc/hacking.md and doc/make_cheatsheet.md back i… (#5963)Jemma Issroff
Add information from doc/hacking.md and doc/make_cheatsheet.md back into contributing docs Notes: Merged-By: peterzhu2118 <peter@peterzhu.ca>
2022-05-27Show ASAN_OPTIONS in hacking guide.Samuel Williams
Notes: Merged: https://github.com/ruby/ruby/pull/5950
2022-05-26Simplify the autoload require logic.Samuel Williams
Notes: Merged: https://github.com/ruby/ruby/pull/5945
2022-05-25Retain reference to blocking fibers.Samuel Williams
Notes: Merged: https://github.com/ruby/ruby/pull/5926
2022-05-25Add support for address sanitizer for amd64 and arm64.Samuel Williams
Notes: Merged: https://github.com/ruby/ruby/pull/5926
2022-05-21[ruby/optparse] Fix typo in documentationydah
- "hypnen" -> "hyphen" - "hadler" -> "handler" https://github.com/ruby/optparse/commit/e70e689ded
2022-05-19[DOC] Re-markup as MarkdownNobuyoshi Nakada
2022-05-18[DOC] Use `make gdb-ruby` and `make lldb-ruby` in ↵Kaíque Kandy Koga
doc/contributing/building_ruby.md Notes: Merged: https://github.com/ruby/ruby/pull/5908 Merged-By: nobu <nobu@ruby-lang.org>
2022-05-12Quick markup fixAlexey Mostovoy
Notes: Merged: https://github.com/ruby/ruby/pull/5902
2022-05-11Add a separate doc for contributing to stdlibs [ci skip]Stan Lo
co-authored-by: Peter Zhu <peter@peterzhu.ca> Notes: Merged: https://github.com/ruby/ruby/pull/5901
2022-05-11Improve documentation on contributing to RubyJemma Issroff
co-authored-by: Peter Zhu <peter@peterzhu.ca> co-authored-by: Stan Lo <stan001212@gmail.com> Notes: Merged: https://github.com/ruby/ruby/pull/5899
2022-05-07Replace with https://github.com [ci skip]Kazuhiro NISHIYAMA
2022-05-05Link from printf methods to format spec doc (#5886)Burdette Lamar
Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-05-05* remove trailing spaces. [ci skip]git
2022-05-04[DOC] More on format specs (#5877)Burdette Lamar
* Update doc/format_specifications.rdoc Co-authored-by: Peter Zhu <peter@peterzhu.ca> Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-05-04[DOC] mention macros for public headersNobuyoshi Nakada
2022-05-02[DOC] Some YJIT dependencies are no longer requiredAlan Wu
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]: https://github.com/capstone-rust/capstone-rs/blob/c31409905a9fc4581133de248fcd0a66b2c37e36/capstone-sys/build.rs#L143
2022-05-03[DOC] Fix links to doc pagesNobuyoshi Nakada
2022-05-02Fix a typo [ci skip]Kazuhiro NISHIYAMA
2022-05-01Repair internal links (#5866)Burdette Lamar
* Repair internal links * Minor changes to format spec Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-04-29[DOC] Format specs (#5857)Burdette Lamar
This new document would eventually replace the format spec discussion at Kernel#sprintf. Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-04-27Update yjit.mdMaxime Chevalier-Boisvert
Fix configure line in YJIT build instructions
2022-04-27Rust YJITAlan Wu
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: https://github.com/Shopify/ruby/commit/1fd9573d8b4b65219f1c2407f30a0a60e537f8be 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> Notes: Merged: https://github.com/ruby/ruby/pull/5826
2022-04-27[DOC] Change URLs from git.ioKazuhiro NISHIYAMA
see https://github.blog/changelog/2022-04-25-git-io-deprecation/
2022-04-25[DOC] Enhanced RDoc for Math module (#5837)Burdette Lamar
Revises intro. Adds "What's Here". Revises methods doc. Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-04-25[DOC] mention assignment expression valuesNobuyoshi Nakada
2022-04-24More details for Rational literals (#5840)Burdette Lamar
Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-04-18[DOC] Enhanced RDoc for MatchData (#5819)Burdette Lamar
Treats: #begin #end #match #match_length Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-04-18[DOC] Enhanced RDoc for MatchData (#5818)Burdette Lamar
Treats: #regexp #names #size #offset Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-04-16[DOC] Enhanced RDoc for Regexp (#5812)Burdette Lamar
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'. Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-04-15[DOC] Enhanced RDoc for Regexp (#5807)Burdette Lamar
Treats: #source #inspect #to_s #casefold? #options #names #named_captures Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-04-15[ruby/optparse] Fix broken links in docsPeter Zhu
https://github.com/ruby/optparse/commit/2bea3b38c3
2022-04-14More details for regexp literals (#5800)Burdette Lamar
Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-04-12Enhanced RDoc for Symbol (#5795)Burdette Lamar
Treats: #== #inspect #name #to_s #to_sym #to_proc #succ #<=> #casecmp #casecmp? #=~ #match #match? Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-04-11Specify which core classes are convertible (#5790)Burdette Lamar
Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-04-07All-in-one RDoc for class String (#5777)Burdette Lamar
Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-04-07Fix a typo [ci skip]Kazuhiro NISHIYAMA
2022-04-06[DOC] Enhanced RDoc for string slices (#5769)Burdette Lamar
Creates file doc/string/slices.rdoc that the string slicing methods can link to. Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-04-04Enhanced RDoc for String#index (#5759)Burdette Lamar
Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-04-03[DOC] Enhanced RDoc for String (#5753)Burdette Lamar
Treats: #length #bytesize Notes: Merged-By: BurdetteLamar <BurdetteLamar@Yahoo.com>
2022-04-03[DOC] Describe append_{c,cpp,ld}flagsv3_2_0_preview1Nobuyoshi Nakada
generated by cgit v1.2.3 (git 2.25.1) at 2024-04-30 13:56:40 +0000