debug 1.9.2 → 1.11.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +122 -92
- data/debug.gemspec +1 -0
- data/lib/debug/config.rb +41 -35
- data/lib/debug/console.rb +22 -11
- data/lib/debug/frame_info.rb +3 -1
- data/lib/debug/server.rb +10 -1
- data/lib/debug/server_cdp.rb +1 -1
- data/lib/debug/server_dap.rb +1 -1
- data/lib/debug/session.rb +15 -7
- data/lib/debug/thread_client.rb +6 -4
- data/lib/debug/version.rb +1 -1
- data/misc/README.md.erb +117 -91
- metadata +4 -3
data/misc/README.md.erb
CHANGED
@@ -16,38 +16,38 @@ New debug.rb has several advantages:
|
|
16
16
|
| Frontend | [Console](https://github.com/ruby/debug#invoke-as-a-remote-debuggee) | [VSCode](https://github.com/ruby/debug#vscode-integration) | [Chrome DevTool](#chrome-devtool-integration) |
|
17
17
|
| ----------- | -------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | --------------------------------------------- |
|
18
18
|
| Connection | UDS, TCP/IP | UDS, TCP/IP | TCP/IP |
|
19
|
-
| Requirement |
|
19
|
+
| Requirement | None | [vscode-rdbg](https://marketplace.visualstudio.com/items?itemName=KoichiSasada.vscode-rdbg) | Chrome |
|
20
20
|
|
21
21
|
* Extensible: application can introduce debugging support in several ways:
|
22
22
|
* By `rdbg` command
|
23
23
|
* By loading libraries with `-r` command line option
|
24
24
|
* By calling Ruby's method explicitly
|
25
25
|
* Misc
|
26
|
-
* Support threads (almost done) and
|
27
|
-
* Support suspending and entering
|
26
|
+
* Support threads (almost done) and Ractors (TODO).
|
27
|
+
* Support suspending and entering the debug console with `Ctrl-C` at most of timing.
|
28
28
|
* Show parameters on backtrace command.
|
29
|
-
* Support recording
|
29
|
+
* Support recording and replay debugging.
|
30
30
|
|
31
31
|
# Installation
|
32
32
|
|
33
|
-
```
|
33
|
+
```console
|
34
34
|
$ gem install debug
|
35
35
|
```
|
36
36
|
|
37
|
-
|
37
|
+
Alternatively, specify `-Ipath/to/debug/lib` in `RUBYOPT`, or as a Ruby command-line option
|
38
|
+
This is especially useful for debugging this gem during development.
|
38
39
|
|
39
|
-
If
|
40
|
+
If using Bundler, add the following to your Gemfile:
|
40
41
|
|
41
|
-
```
|
42
|
+
```ruby
|
42
43
|
gem "debug", ">= 1.0.0"
|
43
44
|
```
|
44
45
|
|
45
|
-
(The version constraint is important; `debug < 1.0.0` is an older,
|
46
|
-
abandoned gem that is completely different from this product.)
|
46
|
+
(The version constraint is important; `debug < 1.0.0` is an older, abandoned gem that is completely different from this product.)
|
47
47
|
|
48
48
|
# HOW TO USE
|
49
49
|
|
50
|
-
To use
|
50
|
+
To use the debugger, you will do roughly the following steps:
|
51
51
|
|
52
52
|
1. Set breakpoints.
|
53
53
|
2. Run a program with the debugger.
|
@@ -63,22 +63,23 @@ To use a debugger, roughly you will do the following steps:
|
|
63
63
|
|
64
64
|
## Invoke with the debugger
|
65
65
|
|
66
|
-
There are several
|
66
|
+
There are several ways to invoke the debugger, depending on your needs, preferences, and the environment.
|
67
67
|
|
68
68
|
### Modify source code with [`binding.break`](#bindingbreak-method) (similar to `binding.pry` or `binding.irb`)
|
69
69
|
|
70
|
-
If you can modify the source code, you can use the debugger by adding `require 'debug'` at the top of your program and putting [`binding.break`](#bindingbreak-method) method into lines where you want to stop as breakpoints
|
70
|
+
If you can modify the source code, you can use the debugger by adding `require 'debug'` at the top of your program and putting [`binding.break`](#bindingbreak-method) method into lines where you want to stop as breakpoints.
|
71
|
+
This is similar to how `binding.pry` and `binding.irb` work.
|
71
72
|
|
72
|
-
|
73
|
+
`binding.break` has two aliases which do the same thing:
|
73
74
|
|
74
75
|
- `binding.b`
|
75
76
|
- `debugger`
|
76
77
|
|
77
78
|
After that, run the program as usual and you will enter the debug console at breakpoints you inserted.
|
78
79
|
|
79
|
-
The following example
|
80
|
+
The following is an example of the [`binding.break`](#bindingbreak-method) method.
|
80
81
|
|
81
|
-
```
|
82
|
+
```console
|
82
83
|
$ cat target.rb # Sample program
|
83
84
|
require 'debug'
|
84
85
|
|
@@ -140,10 +141,11 @@ d => 4
|
|
140
141
|
|
141
142
|
### Invoke the program from the debugger as a traditional debuggers
|
142
143
|
|
143
|
-
If you don't want to modify the source code, you can
|
144
|
-
|
144
|
+
If you don't want to modify the source code, you can use the `rdbg` command (or `bundle exec rdbg`) to run the program with the debugger.
|
145
|
+
This is similar to how you'd launch a program with `ruby program.rb`.
|
146
|
+
Then you can set breakpoints with the debug command `break` (`b` for short).
|
145
147
|
|
146
|
-
```
|
148
|
+
```console
|
147
149
|
$ cat target.rb # Sample program
|
148
150
|
a = 1
|
149
151
|
b = 2
|
@@ -166,9 +168,11 @@ DEBUGGER: Session start (pid: 7656)
|
|
166
168
|
(rdbg)
|
167
169
|
```
|
168
170
|
|
169
|
-
`rdbg` command suspends the program at the beginning of the given script (`target.rb` in this case) and you can use debug commands
|
171
|
+
The `rdbg` command suspends the program at the beginning of the given script (`target.rb` in this case) and you can use debug commands to control execution from there.
|
172
|
+
`(rdbg)` is the console prompt.
|
173
|
+
Let's set breakpoints on line 3 and line 5 with `break` command (`b` for short).
|
170
174
|
|
171
|
-
```
|
175
|
+
```console
|
172
176
|
(rdbg) break 3 # set breakpoint at line 3
|
173
177
|
#0 BP - Line /mnt/c/ko1/src/rb/ruby-debug/target.rb:3 (line)
|
174
178
|
|
@@ -180,9 +184,10 @@ DEBUGGER: Session start (pid: 7656)
|
|
180
184
|
#1 BP - Line /mnt/c/ko1/src/rb/ruby-debug/target.rb:5 (line)
|
181
185
|
```
|
182
186
|
|
183
|
-
You can see that two breakpoints are registered.
|
187
|
+
You can see that two breakpoints are registered.
|
188
|
+
Let's continue the program by using the `continue` command.
|
184
189
|
|
185
|
-
```
|
190
|
+
```console
|
186
191
|
(rdbg) continue
|
187
192
|
[1, 7] in target.rb
|
188
193
|
1| a = 1
|
@@ -199,11 +204,11 @@ Stop by #0 BP - Line /mnt/c/ko1/src/rb/ruby-debug/target.rb:3 (line)
|
|
199
204
|
(rdbg)
|
200
205
|
```
|
201
206
|
|
202
|
-
You can see that we
|
203
|
-
Let's see the local variables with the `info` command, and continue
|
204
|
-
|
207
|
+
You can see that we stopped at line 3.
|
208
|
+
Let's see the local variables with the `info` command, and continue execution with the `continue`.
|
209
|
+
The program will then suspend at line 5 and you can use the `info` command again.
|
205
210
|
|
206
|
-
```
|
211
|
+
```console
|
207
212
|
(rdbg) info
|
208
213
|
=>#0 <main> at target.rb:3
|
209
214
|
%self => main
|
@@ -237,25 +242,28 @@ d => 4
|
|
237
242
|
[1, 2, 3, 4]
|
238
243
|
```
|
239
244
|
|
240
|
-
|
245
|
+
NOTE: When using `rdbg` you can suspend your application with `C-c` (SIGINT) and enter the debug console.
|
241
246
|
It will help if you want to know what the program is doing.
|
242
247
|
|
243
248
|
### Use `rdbg` with commands written in Ruby
|
244
249
|
|
245
|
-
If you want to run
|
250
|
+
If you want to run an executable written in Ruby like `rake`, `rails`, `bundle`, `rspec`, and so on, you can use `rdbg -c` option.
|
246
251
|
|
247
|
-
* Without `-c` option, `rdbg <name>` means that `<name>` is Ruby script and
|
248
|
-
* With `-c` option, `rdbg -c <name>` means that `<name>` is
|
252
|
+
* Without the `-c` option, `rdbg <name>` means that `<name>` is a Ruby script and it is invoked like `ruby <name>` with the debugger.
|
253
|
+
* With the `-c` option, `rdbg -c <name>` means that `<name>` is an executable in `PATH` and simply invokes it with the debugger.
|
249
254
|
|
250
255
|
Examples:
|
256
|
+
|
251
257
|
* `rdbg -c -- rails server`
|
252
258
|
* `rdbg -c -- bundle exec ruby foo.rb`
|
253
259
|
* `rdbg -c -- bundle exec rake test`
|
254
|
-
* `rdbg -c -- ruby target.rb` is same as `rdbg target.rb`
|
260
|
+
* `rdbg -c -- ruby target.rb` is the same as `rdbg target.rb`
|
255
261
|
|
256
|
-
NOTE: `--` is needed to separate the command line options for `rdbg`
|
262
|
+
NOTE: `--` is needed to separate the command line options for `rdbg` from the executable being invoked, and its options.
|
263
|
+
For example, `rdbg -c rake -T` would be parsed as `rdbg -c -T -- rake`, which is incorrect.
|
264
|
+
It should be `rdbg -c -- rake -T`.
|
257
265
|
|
258
|
-
NOTE: If you want to use
|
266
|
+
NOTE: If you want to use Bundler (`bundle` executable), you need to add `gem 'debug'` to your `Gemfile`.
|
259
267
|
|
260
268
|
### Using VSCode
|
261
269
|
|
@@ -275,12 +283,13 @@ Please see the extension page for more details.
|
|
275
283
|
|
276
284
|
## Remote debugging
|
277
285
|
|
278
|
-
You can use this debugger as a remote debugger.
|
286
|
+
You can use this debugger as a remote debugger.
|
287
|
+
For example, it will help in the following situations:
|
279
288
|
|
280
289
|
* Your application does not run on TTY, and it is hard to use `binding.pry` or `binding.irb`.
|
281
290
|
* Your application is running on a Docker container, and there is no TTY.
|
282
291
|
* Your application is running as a daemon.
|
283
|
-
* Your application uses pipe for STDIN or STDOUT
|
292
|
+
* Your application uses pipe for `STDIN` or `STDOUT`.
|
284
293
|
* Your application is running as a daemon and you want to query the running status (checking a backtrace and so on).
|
285
294
|
|
286
295
|
You can run your application as a remote debuggee, and the remote debugger console can attach to the debuggee anytime.
|
@@ -296,10 +305,11 @@ There are multiple ways to run your program as a debuggee:
|
|
296
305
|
|
297
306
|
#### `rdbg --open` (or `rdbg -O` for short)
|
298
307
|
|
299
|
-
|
308
|
+
Launch a script with `rdbg --open target.rb` to run `target.rb` as a debuggee program.
|
309
|
+
It also opens the network port and suspends at the beginning of `target.rb`.
|
300
310
|
|
301
|
-
```
|
302
|
-
$
|
311
|
+
```console
|
312
|
+
$ rdbg --open target.rb
|
303
313
|
DEBUGGER: Session start (pid: 7773)
|
304
314
|
DEBUGGER: Debugger can attach via UNIX domain socket (/home/ko1/.ruby-debug-sock/ruby-debug-ko1-7773)
|
305
315
|
DEBUGGER: wait for debugger connection...
|
@@ -309,7 +319,7 @@ By default, `rdbg --open` uses UNIX domain socket and generates the path name au
|
|
309
319
|
|
310
320
|
You can connect to the debuggee with `rdbg --attach` command (`rdbg -A` for short).
|
311
321
|
|
312
|
-
```
|
322
|
+
```console
|
313
323
|
$ rdbg -A
|
314
324
|
[1, 7] in target.rb
|
315
325
|
=> 1| a = 1
|
@@ -324,35 +334,41 @@ $ rdbg -A
|
|
324
334
|
(rdbg:remote)
|
325
335
|
```
|
326
336
|
|
327
|
-
If there are no other
|
337
|
+
If there are no other files in the default directory, `rdbg --attach` will automatically connect to the UNIX domain socket listed.
|
338
|
+
If there are multiple files, you need to specify which to use.
|
328
339
|
|
329
|
-
When `rdbg --attach` connects to the debuggee, you can use any debug commands (set breakpoints, continue the program, and so on) like the local debug console.
|
340
|
+
When `rdbg --attach` connects to the debuggee, you can use any debug commands (set breakpoints, continue the program, and so on) like the local debug console.
|
341
|
+
When a debuggee program exits, the remote console will also terminate.
|
330
342
|
|
331
|
-
NOTE: If you use the `quit` command, only the remote console exits and the debuggee program continues to run (and you can connect it again).
|
343
|
+
NOTE: If you use the `quit` command, only the remote console exits and the debuggee program continues to run (and you can connect it again).
|
344
|
+
If you want to exit the debuggee program, use `kill` command.
|
332
345
|
|
333
|
-
If you want to use TCP/IP for
|
346
|
+
If you want to use TCP/IP for remote debugging, you need to specify the port and host with `--port` like `rdbg --open --port 12345` and it binds to `localhost:12345`.
|
347
|
+
You can add an optional `--port_range` to try multiple ports in a reliable way.
|
348
|
+
For example, `rdbg --open --port 12345 --port_range 10` will try to bind to 12345, 12346, 12347,… until it finds an available port.
|
334
349
|
|
335
350
|
To connect to the debuggee, you need to specify the port.
|
336
351
|
|
337
|
-
```
|
352
|
+
```console
|
338
353
|
$ rdbg --attach 12345
|
339
354
|
```
|
340
355
|
|
341
356
|
If you want to choose the host to bind, you can use `--host` option.
|
342
|
-
|
357
|
+
Messages communicated between the debugger and the debuggee are *NOT* encrypted so please use remote debugging carefully.
|
343
358
|
|
344
359
|
#### `require 'debug/open'` in a program
|
345
360
|
|
346
|
-
If you can modify the program, you can open the debugging port by adding `require 'debug/open'`
|
361
|
+
If you can modify the program, you can open the debugging port by adding `require 'debug/open'` in the program.
|
347
362
|
|
348
363
|
If you don't want to stop the program at the beginning, you can also use `require 'debug/open_nonstop'`.
|
349
364
|
Using `debug/open_nonstop` is useful if you want to open a backdoor to the application.
|
350
365
|
However, it is also dangerous because it can become another vulnerability.
|
351
366
|
Please use it carefully.
|
352
367
|
|
353
|
-
By default, UNIX domain socket is used for the debugging port.
|
368
|
+
By default, UNIX domain socket is used for the debugging port.
|
369
|
+
To use TCP/IP, you can set the `RUBY_DEBUG_PORT` environment variable.
|
354
370
|
|
355
|
-
```
|
371
|
+
```console
|
356
372
|
$ RUBY_DEBUG_PORT=12345 ruby target.rb
|
357
373
|
```
|
358
374
|
|
@@ -364,9 +380,7 @@ You can attach with external debugger frontend with VSCode and Chrome.
|
|
364
380
|
$ rdbg --open=[frontend] target.rb
|
365
381
|
```
|
366
382
|
|
367
|
-
will open a debug port and `[frontend]` can attach to the port.
|
368
|
-
|
369
|
-
Also `open` command allows opening the debug port.
|
383
|
+
This will open a debug port and the `[frontend]` can attach to the port.
|
370
384
|
|
371
385
|
#### VSCode integration
|
372
386
|
|
@@ -374,9 +388,9 @@ Also `open` command allows opening the debug port.
|
|
374
388
|
|
375
389
|
If you don't run a debuggee Ruby process on VSCode, you can attach it to VSCode later with the following steps.
|
376
390
|
|
377
|
-
`rdbg --open=vscode` opens the debug port and tries to invoke the VSCode (`code`
|
391
|
+
`rdbg --open=vscode` opens the debug port and tries to invoke the VSCode (`code` executable).
|
378
392
|
|
379
|
-
```
|
393
|
+
```console
|
380
394
|
$ rdbg --open=vscode target.rb
|
381
395
|
DEBUGGER: Debugger can attach via UNIX domain socket (/tmp/ruby-debug-sock-1000/ruby-debug-ko1-27706)
|
382
396
|
DEBUGGER: wait for debugger connection...
|
@@ -384,11 +398,11 @@ Launching: code /tmp/ruby-debug-vscode-20211014-27706-gd7e85/ /tmp/ruby-debug-vs
|
|
384
398
|
DEBUGGER: Connected.
|
385
399
|
```
|
386
400
|
|
387
|
-
|
401
|
+
It tries to invoke the new VSCode window and VSCode will attach to the debuggee Ruby program automatically.
|
388
402
|
|
389
|
-
You can also use `open vscode`
|
403
|
+
You can also use `open vscode` in a REPL.
|
390
404
|
|
391
|
-
```
|
405
|
+
```console
|
392
406
|
$ rdbg target.rb
|
393
407
|
[1, 8] in target.rb
|
394
408
|
1|
|
@@ -407,9 +421,9 @@ Launching: code /tmp/ruby-debug-vscode-20211014-28337-kg9dm/ /tmp/ruby-debug-vsc
|
|
407
421
|
DEBUGGER: Connected.
|
408
422
|
```
|
409
423
|
|
410
|
-
If the machine which runs the Ruby process doesn't have a `code`
|
424
|
+
If the machine which runs the Ruby process doesn't have a `code` executable on `$PATH`, the following message will be shown:
|
411
425
|
|
412
|
-
```
|
426
|
+
```console
|
413
427
|
(rdbg) open vscode
|
414
428
|
DEBUGGER: wait for debugger connection...
|
415
429
|
DEBUGGER: Debugger can attach via UNIX domain socket (/tmp/ruby-debug-sock-1000/ruby-debug-ko1-455)
|
@@ -425,15 +439,13 @@ If your application is running on a SSH remote host, please try:
|
|
425
439
|
|
426
440
|
```
|
427
441
|
|
428
|
-
and try to use the proposed commands.
|
429
|
-
|
430
442
|
Note that you can attach with `rdbg --attach` and continue REPL debugging.
|
431
443
|
|
432
444
|
#### Chrome DevTool integration
|
433
445
|
|
434
|
-
|
446
|
+
Using `rdbg --open=chrome` will show the following message:
|
435
447
|
|
436
|
-
```
|
448
|
+
```console
|
437
449
|
$ rdbg target.rb --open=chrome
|
438
450
|
DEBUGGER: Debugger can attach via TCP/IP (127.0.0.1:43633)
|
439
451
|
DEBUGGER: With Chrome browser, type the following URL in the address-bar:
|
@@ -443,20 +455,25 @@ DEBUGGER: With Chrome browser, type the following URL in the address-bar:
|
|
443
455
|
DEBUGGER: wait for debugger connection...
|
444
456
|
```
|
445
457
|
|
446
|
-
Type
|
458
|
+
Type the following in the address bar on Chrome browser, and you can continue the debugging with chrome browser:
|
459
|
+
|
460
|
+
```txt
|
461
|
+
devtools://devtools/bundled/inspector.html?v8only=true&panel=sources&ws=127.0.0.1:57231/b32a55cd-2eb5-4c5c-87d8-b3dfc59d80ef`
|
462
|
+
```
|
447
463
|
|
448
|
-
|
464
|
+
Similar to VSCode, you can use `open chrome` to open the debugger in Chrome.
|
449
465
|
|
450
|
-
For more information about how to use Chrome debugging,
|
466
|
+
For more information about how to use Chrome debugging, [see the devtools docs](https://developer.chrome.com/docs/devtools/).
|
451
467
|
|
452
468
|
## Configuration
|
453
469
|
|
454
470
|
You can configure the debugger's behavior with debug commands and environment variables.
|
455
|
-
When the debug session is started,
|
471
|
+
When the debug session is started, some [initialization scripts](#initial-scripts) (e.g., `~/.rdbgrc`) are loaded, allowing you to configure the debugger's behavior to your needs and preferences.
|
456
472
|
|
457
473
|
### Configuration list
|
458
474
|
|
459
|
-
You can configure the debugger's behavior with environment variables and `config` command.
|
475
|
+
You can configure the debugger's behavior with environment variables and `config` command.
|
476
|
+
Each configuration has an environment variable and a name which can be specified by `config` command.
|
460
477
|
|
461
478
|
```
|
462
479
|
# configuration example
|
@@ -479,7 +496,7 @@ There are other environment variables:
|
|
479
496
|
|
480
497
|
### Initial scripts
|
481
498
|
|
482
|
-
If there is `~/.rdbgrc
|
499
|
+
If there is a `~/.rdbgrc` file it is loaded as an initialization script (which contains debug commands) when the debug session is started.
|
483
500
|
|
484
501
|
* `RUBY_DEBUG_INIT_SCRIPT` environment variable can specify the initial script file.
|
485
502
|
* You can specify the initial script with `rdbg -x initial_script` (like gdb's `-x` option).
|
@@ -487,7 +504,7 @@ If there is `~/.rdbgrc`, the file is loaded as an initial script (which contains
|
|
487
504
|
Initial scripts are useful to write your favorite configurations.
|
488
505
|
For example, you can set breakpoints with `break file:123` in `~/.rdbgrc`.
|
489
506
|
|
490
|
-
If there
|
507
|
+
If there is a `~/.rdbgrc.rb` file it is also loaded as a Ruby script when the debug session is started.
|
491
508
|
|
492
509
|
## Debug command on the debug console
|
493
510
|
|
@@ -496,16 +513,19 @@ On the debug console, you can use the following debug commands.
|
|
496
513
|
There are additional features:
|
497
514
|
|
498
515
|
* `<expr>` without debug command is almost the same as `pp <expr>`.
|
499
|
-
* If the input line `<expr>` does *NOT* start with any debug command, the line `<expr>` will be evaluated as a Ruby expression, and the result will be printed with `pp` method.
|
500
|
-
|
501
|
-
*
|
516
|
+
* If the input line `<expr>` does *NOT* start with any debug command, the line `<expr>` will be evaluated as a Ruby expression, and the result will be printed with `pp` method.
|
517
|
+
So that the input `foo.bar` is the same as `pp foo.bar`.
|
518
|
+
* If `<expr>` is recognized as a debug command, of course, it is not evaluated as a Ruby expression but is executed as debug command.
|
519
|
+
For example, you can not evaluate such single-letter local variables `i`, `b`, `n`, `c` because they are single-letter debug commands. Use `p i` instead.
|
520
|
+
* For consistency, the author (Koichi Sasada) recommends using the `p`, `pp`, or `eval` command to evaluate the Ruby expression every time.
|
502
521
|
* `Enter` without any input repeats the last command (useful when repeating `step`s) for some commands.
|
503
522
|
* `Ctrl-D` is equal to `quit` command.
|
504
523
|
* [debug command compare sheet - Google Sheets](https://docs.google.com/spreadsheets/d/1TlmmUDsvwK4sSIyoMv-io52BUUz__R5wpu-ComXlsw0/edit?usp=sharing)
|
505
524
|
|
506
|
-
You can use the following debug commands.
|
507
|
-
|
508
|
-
The
|
525
|
+
You can use the following debug commands.
|
526
|
+
Each command should be written in 1 line.
|
527
|
+
The `[…]` notation means this part can be eliminated. For example, `s[tep]` means `s` or `step` is a valid command. `ste` is not valid.
|
528
|
+
The `<…>` notation means the argument.
|
509
529
|
|
510
530
|
<%= DEBUGGER__.help %>
|
511
531
|
|
@@ -522,7 +542,7 @@ To switch to the IRB console, simply use the `irb` command in the debug console.
|
|
522
542
|
|
523
543
|
Once activated, you'll notice the prompt changes to:
|
524
544
|
|
525
|
-
```
|
545
|
+
```console
|
526
546
|
irb:rdbg(main):001>
|
527
547
|
```
|
528
548
|
|
@@ -549,9 +569,12 @@ You can start debugging without `rdbg` command by requiring the following librar
|
|
549
569
|
You need to require one of them at the very beginning of the application.
|
550
570
|
Using `ruby -r` (for example `ruby -r debug/start target.rb`) is another way to invoke with debugger.
|
551
571
|
|
552
|
-
NOTE: Until Ruby 3.0, there is old `lib/debug.rb` standard library.
|
572
|
+
NOTE: Until Ruby 3.0, there is old `lib/debug.rb` in the standard library.
|
573
|
+
`lib/debug.rb` was not maintained well in recent years, and the purpose of this library is to rewrite old `lib/debug.rb` with recent techniques.
|
574
|
+
|
575
|
+
So, if this gem is not installed, or if the `Gemfile` doesn't include this gem and `bundle exec` is used, you will see the following output:
|
553
576
|
|
554
|
-
```
|
577
|
+
```console
|
555
578
|
$ ruby -r debug -e0
|
556
579
|
.../2.7.3/lib/ruby/2.7.0/x86_64-linux/continuation.so: warning: callcc is obsolete; use Fiber instead
|
557
580
|
Debug.rb
|
@@ -561,16 +584,15 @@ Emacs support available.
|
|
561
584
|
(rdb:1)
|
562
585
|
```
|
563
586
|
|
564
|
-
`lib/debug.rb` was not maintained well in recent years, and the purpose of this library is to rewrite old `lib/debug.rb` with recent techniques.
|
565
|
-
|
566
587
|
#### Start by method
|
567
588
|
|
568
|
-
After loading `debug/session`, you can start a debug session with the following methods.
|
589
|
+
After loading `debug/session`, you can start a debug session with the following methods.
|
590
|
+
They are convenient if you want to specify debug configurations in your program.
|
569
591
|
|
570
592
|
* `DEBUGGER__.start(**kw)`: start debug session with local console.
|
571
|
-
* `DEBUGGER__.open(**kw)`: open debug port with configuration (without configurations open with UNIX domain socket)
|
572
|
-
* `DEBUGGER__.open_unix(**kw)`: open debug port with UNIX domain socket
|
573
|
-
* `DEBUGGER__.open_tcp(**kw)`: open debug port with TCP/IP
|
593
|
+
* `DEBUGGER__.open(**kw)`: open debug port with configuration (without configurations open with UNIX domain socket).
|
594
|
+
* `DEBUGGER__.open_unix(**kw)`: open debug port with UNIX domain socket.
|
595
|
+
* `DEBUGGER__.open_tcp(**kw)`: open debug port with TCP/IP.
|
574
596
|
|
575
597
|
For example:
|
576
598
|
|
@@ -584,24 +606,28 @@ DEBUGGER__.start(no_color: true, # disable colorize
|
|
584
606
|
|
585
607
|
### `binding.break` method
|
586
608
|
|
587
|
-
`binding.break` (or `binding.b`)
|
609
|
+
`binding.break` (or `binding.b`) sets a breakpoint at that line.
|
610
|
+
It also has several keywords.
|
588
611
|
|
589
612
|
If `do: 'command'` is specified, the debugger suspends the program, runs the `command` as a debug command, and continues the program.
|
590
613
|
It is useful if you only want to call a debug command and don't want to stop there.
|
614
|
+
For example:
|
591
615
|
|
592
|
-
```
|
616
|
+
```ruby
|
593
617
|
def initialize
|
594
618
|
@a = 1
|
595
619
|
binding.b do: 'info \n watch @a'
|
596
620
|
end
|
597
621
|
```
|
598
622
|
|
599
|
-
In this case, execute the `info` command then register a watch breakpoint for `@a` and continue to run.
|
623
|
+
In this case, execute the `info` command, then register a watch breakpoint for `@a` and continue to run.
|
624
|
+
You can also use `;;` instead of `\n` to separate your commands.
|
600
625
|
|
601
626
|
If `pre: 'command'` is specified, the debugger suspends the program and runs the `command` as a debug command, and keeps suspended.
|
602
627
|
It is useful if you have operations before suspend.
|
628
|
+
For example:
|
603
629
|
|
604
|
-
```
|
630
|
+
```ruby
|
605
631
|
def foo
|
606
632
|
binding.b pre: 'p bar()'
|
607
633
|
...
|
@@ -612,7 +638,7 @@ In this case, you can see the result of `bar()` every time you stop there.
|
|
612
638
|
|
613
639
|
## rdbg command help
|
614
640
|
|
615
|
-
```
|
641
|
+
```console
|
616
642
|
<%= `exe/rdbg --help` %>
|
617
643
|
```
|
618
644
|
|
@@ -623,7 +649,7 @@ In this case, you can see the result of `bar()` every time you stop there.
|
|
623
649
|
|
624
650
|
# Contributing
|
625
651
|
|
626
|
-
Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/debug.
|
652
|
+
Bug reports and pull requests are welcome on GitHub at [https://github.com/ruby/debug]().
|
627
653
|
This debugger is not mature so your feedback will help us.
|
628
654
|
|
629
655
|
Please also check the [contributing guideline](/CONTRIBUTING.md).
|
metadata
CHANGED
@@ -1,13 +1,13 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: debug
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.11.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Koichi Sasada
|
8
8
|
bindir: exe
|
9
9
|
cert_chain: []
|
10
|
-
date:
|
10
|
+
date: 2025-06-17 00:00:00.000000000 Z
|
11
11
|
dependencies:
|
12
12
|
- !ruby/object:Gem::Dependency
|
13
13
|
name: irb
|
@@ -89,6 +89,7 @@ licenses:
|
|
89
89
|
metadata:
|
90
90
|
homepage_uri: https://github.com/ruby/debug
|
91
91
|
source_code_uri: https://github.com/ruby/debug
|
92
|
+
changelog_uri: https://github.com/ruby/debug/releases/tag/v1.11.0
|
92
93
|
rdoc_options: []
|
93
94
|
require_paths:
|
94
95
|
- lib
|
@@ -103,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
103
104
|
- !ruby/object:Gem::Version
|
104
105
|
version: '0'
|
105
106
|
requirements: []
|
106
|
-
rubygems_version: 3.6.
|
107
|
+
rubygems_version: 3.6.2
|
107
108
|
specification_version: 4
|
108
109
|
summary: Debugging functionality for Ruby
|
109
110
|
test_files: []
|