52 Commits

Author SHA1 Message Date
Étienne Barrié
22dfa250a8 More comprehensive debugging configuration 2025-06-05 18:01:11 +02:00
Stan Lo
ab22f3910d Mention VS Code debugger configuration in debugging guide 2025-04-18 13:56:57 +09:00
Edouard CHIN
366462bd46 - Add a mention to git 2.32 in the building ruby documentation:
I had issues building Ruby as I was using git 2.30.
  The error was:

  > file2lastrev.rb: git rev-parse failed error: could not expand
  > include path '~/.gitcinclude'

  The default system git config includes paths making use of `$HOME`,
  but that env variable gets removed when building: 7070b1b196/tool/lib/vcs.rb (L546-L547)

  It works with git `>= 2.32` thanks to the `GIT_CONFIG_SYSTEM`
  feature which gets set to a Null IO in order to override
  the system gitconfig. 7070b1b196/tool/lib/vcs.rb (L549)
2025-01-31 11:52:57 +09:00
Alexander Momchilov
8cc47c9050
Improve "Building Ruby" docs (#12320)
* Clarify “Building Ruby” docs

* Fix test examples to work from `build` dir

* Clarify “Testing Ruby” examples with real examples

All the commands should run correctly by default, without the user needing to modify them. This builds confidence that the relative paths are working correct from within the `build` directory.

Also, let’s use a consistent example throughout, for greater clarity.

* Improve examples to use `-v` flag in-context

This shows the correct way to combine `-v` with another parameter, e.g. a specific file to test.

* Other readability improvements

* Clarify `make` implementation support
2024-12-12 17:55:23 -08:00
Alexander Momchilov
0ea5c13bc6
[DOC] Improve formatting in Markdown files (#12322)
* Fix WASM bullet/code indentation

* Use `console` code highlighting where appropriate

… which handles the prefix `$` correctly.

* Migrate feature proposal template to MarkDown

* Set language on code blocks
2024-12-12 17:49:45 -08:00
Nobuyoshi Nakada
a7d510808d
[DOC] --with-opt-dir options and CONFIGURE_ARGS 2024-11-12 11:37:16 +09: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
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
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
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
jinroq
ebb7552e6d
[Doc] Make build instructions easier to copy-and-paste 2023-07-14 12:52:33 -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
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
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
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
Jemma Issroff
9241d75a61
Add information from doc/hacking.md and doc/make_cheatsheet.md back i… (#5963)
Add information from doc/hacking.md and doc/make_cheatsheet.md back into contributing docs
2022-05-30 23:50:39 -04:00