1berry/ruby
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

More comprehensive debugging configuration

Browse Source
This commit is contained in:
Étienne Barrié 2025-06-05 17:09:47 +02:00 committed by Jean Boussier
parent da2453c58d
commit 22dfa250a8
1 changed files with 17 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
doc/contributing/building_ruby.md
View File

@ -260,11 +260,25 @@ This will add launch configurations for debugging Ruby itself by running `test.r
### Compiling for Debugging
You should configure Ruby without optimization and other flags that may
interfere with debugging:
You can compile Ruby with the `RUBY_DEBUG` macro to enable debugging on some
features. One example is debugging object shapes in Ruby with
`RubyVM::Shape.of(object)`.
Additionally Ruby can be compiled to support the `RUBY_DEBUG` environment
variable to enable debugging on some features. An example is using
`RUBY_DEBUG=gc_stress` to debug GC-related issues.
There is also support for the `RUBY_DEBUG_LOG` environment variable to log a
lot of information about what the VM is doing, via the `USE_RUBY_DEBUG_LOG`
macro.
You should also configure Ruby without optimization and other flags that may
interfere with debugging by changing the optimization flags.
Bringing it all together:
```sh
./configure --enable-debug-env optflags="-O0 -fno-omit-frame-pointer"
./configure cppflags="-DRUBY_DEBUG=1 -DUSE_RUBY_DEBUG_LOG=1" --enable-debug-env optflags="-O0 -fno-omit-frame-pointer"
```
### Building with Address Sanitizer