60 Commits
Author SHA1 Message Date
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 WilliamsandNobuyoshi Nakada 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 KanekoandNobuyoshi Nakada 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
Hiroshi SHIBATA 31d37e2406 Mentioned gmp at requirements 2023-02-07 21:38:24 +09:00
Hiroshi SHIBATA 5ee39ea67f Added tarball instruction to building_ruby.md 2023-02-07 14:21:18 +09: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
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
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
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
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
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 bcb72f503c [DOC] Add note about method names (#6620) 2022-10-24 08:56:13 -05: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