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

1199 Коммитов

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