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 )
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
...
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 )
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