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

1391 Коммитов

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