Skip to content

Commit 2251b2d

Browse files
committed
Add a summary table on how to start remote debuggee
1 parent 2586199 commit 2251b2d

File tree

2 files changed

+12
-2
lines changed

2 files changed

+12
-2
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -280,7 +280,12 @@ You can run your application as a remote debuggee and the remote debugger consol
280280

281281
### Invoke as a remote debuggee
282282

283-
There are two ways to invoke a script as remote debuggee: Use `rdbg --open` and require `debug/open` (or `debug/open_nonstop`).
283+
There are multiple ways to run your program as a debuggee:
284+
285+
Stop at program start | [`rdbg` option](https://github.com/ruby/debug#rdbg---open-or-rdbg--o-for-short) | [require](https://github.com/ruby/debug#require-debugopen-in-a-program) | [debugger API](https://github.com/ruby/debug#start-by-method)
286+
---|---|---|---|
287+
Yes | `rdbg --open` | `require "debug/open"` | `DEBUGGER__.open`
288+
No | `rdbg --open --nonstop` | `require "debug/open_nonstop"` | `DEBUGGER__.open(nonstop: true)`
284289

285290
#### `rdbg --open` (or `rdbg -O` for short)
286291

misc/README.md.erb

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -280,7 +280,12 @@ You can run your application as a remote debuggee and the remote debugger consol
280280

281281
### Invoke as a remote debuggee
282282

283-
There are two ways to invoke a script as remote debuggee: Use `rdbg --open` and require `debug/open` (or `debug/open_nonstop`).
283+
There are multiple ways to run your program as a debuggee:
284+
285+
Stop at program start | [`rdbg` option](https://github.com/ruby/debug#rdbg---open-or-rdbg--o-for-short) | [require](https://github.com/ruby/debug#require-debugopen-in-a-program) | [debugger API](https://github.com/ruby/debug#start-by-method)
286+
---|---|---|---|
287+
Yes | `rdbg --open` | `require "debug/open"` | `DEBUGGER__.open`
288+
No | `rdbg --open --nonstop` | `require "debug/open_nonstop"` | `DEBUGGER__.open(nonstop: true)`
284289

285290
#### `rdbg --open` (or `rdbg -O` for short)
286291

0 commit comments

Comments
 (0)