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

1229 Коммитов

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