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

79 Коммитов

Автор SHA1 Сообщение Дата
BurdetteLamar e008f0553d [DOC] Add remark about in-brief for method doc 2024-08-08 16:08:47 -04:00
Burdette Lamar f5d193d525
[DOC] Adds "Further Considerations" to documentation_guide.md (#11281) 2024-07-31 16:09:15 -04:00
BurdetteLamar df1cc04301 Add remark about call-seq 2024-07-29 09:15:19 -04:00
cdfzo 087b461c83
[DOC] Fix typo `with` -> `wish` 2024-07-07 13:09:42 +09:00
Nobuyoshi Nakada 1f8c45aa51
[DOC] building_ruby: Move the caution to a footnote 2024-06-02 21:33:02 +09:00
Nobuyoshi Nakada 7e52e3e3f7
[DOC] building_ruby: External library links 
- `OpenSSL` here is not the class.
- libexecinfo on FreeBSD is present in the base system of all
  supported releases, since 2017.
 2024-06-02 21:33:02 +09:00
Nobuyoshi Nakada 457c6b4789
[DOC] building_ruby: Refine links 
Get rid of using ambiguous demonstratives as link anchors, for the
accessibility's sake.
 2024-06-02 21:33:02 +09:00
Nobuyoshi Nakada 5980f14e88
[DOC] building_ruby: Fold long lines 2024-06-02 21:33:01 +09:00
Nobuyoshi Nakada 3eba84fba0
[DOC] Caution about old GNU make 2024-06-02 19:59:05 +09:00
KJ Tsanaktsidis fd2876e6a2 Update ASAN docs to refer to Clang 18's release 
Clang 18 has the bugfix we need, so we no longer need to tell people to
compile Clang from source.
 2024-05-10 10:55:28 +10:00
Hiroshi SHIBATA 7e8d8f250d
Removed obsoleted section because make docs is removed from default make task 2024-04-24 17:19:04 +09:00
Hiroshi SHIBATA 945a0334c7 Update build and install document related https://blade.ruby-lang.org/ruby-dev/39325 2024-04-17 19:56:20 +09:00
KJ Tsanaktsidis e02a06fbf2 Document how to run the tests under ASAN now that they pass! 2024-03-31 21:12:31 +11:00
John Hawthorn b8572c3f16 BASERUBY is now >= 3.0 2024-02-26 14:03:49 -08:00
ydah 303852440a s/bellow/below/ 2024-02-15 17:01:02 +09:00
KJ Tsanaktsidis 1f0fa31834 Fix typo in asan section of building_ruby.md docs 
s/copmiler-rt/compiler-rt/
 2024-02-13 10:07:04 +09:00
Burdette Lamar 4f1a466522
More on auto-link (#9907) 2024-02-12 15:01:46 -05:00
KJ Tsanaktsidis 697ade7bda Update ASAN docs to reflect the current state of things 
I don't really think ASAN works well at all on any version of Ruby from
before https://bugs.ruby-lang.org/issues/20001 was landed. Update the
docs to clarify what works, and what does not work.

Also there's no need to compile at `-O0`; this was probably just hiding
some of the problems with our stack scanning that were fixed in the
above issue.

[Bug #20248]
 2024-02-12 10:52:05 +11:00
Kazuhiro NISHIYAMA 42177a8987
[DOC] Update ruby version in Building Ruby Dependencies 2024-01-18 08:45:09 +09:00
Hiroshi SHIBATA c903cddf55
Typofix under doc directory 2023-12-25 11:17:51 +09:00
Burdette Lamar 715cf9b690
[DOC] More on What's Here (#9099) 
* More on What's Here

* More on What's Here
 2023-12-02 11:46:57 -06:00
Burdette Lamar 12f4e9655e
Add recommendations on link formatting in documentation 2023-11-23 20:39:24 -08:00
Takashi Kokubun ee25ac49f3 [DOC] Use a relative link like other links 
following up on https://github.com/ruby/ruby/pull/8832
 2023-11-06 09:46:37 -08:00
JorandeBoer a763d085e4 Updated building_ruby.md to include reference for building on Windows 
Looking at building_ruby.md it is unclear that you are able to build Ruby on Windows. To fix that a reference has been added to the windows.md file.
 2023-11-06 11:52:31 +09:00
Nobuyoshi Nakada 0061eaddc9
[DOC] `configure -C` tips 2023-10-20 16:33:23 +09:00
Matheus Richard 72f97ee06e
[DOC] Improve docs for how to generate documentation 
It might not be obvious how to get the build directory and the Makefile
set up.
 2023-10-20 08:45:07 +09:00
Jun Aruga 13dafb210e [DOC] testing_ruby.md: Add spec/ for the explanation of the `make check`. 2023-10-14 22:43:41 -07:00
Jun Aruga df1887414a [DOC] testing_ruby.md: Remove the command prompt '$ ` aligning with other parts. 
Remove the command prompt '$ ` aligning with other parts in the document.
 2023-10-14 22:43:41 -07: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
Burdette Lamar 36cd2b2a52
[DOC] Correction for doc guide + TOC fix in File (#8505) 2023-09-24 17:57:21 -04: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
Burdette Lamar 448ff162c4
[DOC] Adding font usage to doc guide (#8255) 2023-08-23 10:09:24 -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
jinroq ebb7552e6d
[Doc] Make build instructions easier to copy-and-paste 2023-07-14 12:52:33 -04:00
Burdette Lamar 6528cf9fcf
[DOC] Fixes for link fragments (#7981) 2023-06-28 09:05:43 -04: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
Jun Aruga 6d450d62fb testing_ruby.md: Update `make test-all` tips [ci skip] 2023-05-26 09:19:38 -04: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
Jemma Issroff 6404a0f2f8 Fix broken link to maintainers page 2023-05-09 12:57:36 +09: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
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
Ezra-Shimon Rosenfeld ddd3c92bf6 [DOC] Add missing word to documentation_guide.md 2023-03-03 09:40:40 +09: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
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