From 2251b2d991452ef8f2c223e35bf5aff7ccb6443e Mon Sep 17 00:00:00 2001 From: st0012 Date: Thu, 19 May 2022 21:40:01 +0100 Subject: [PATCH] Add a summary table on how to start remote debuggee --- README.md | 7 ++++++- misc/README.md.erb | 7 ++++++- 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 52b30e862..c091b0098 100644 --- a/README.md +++ b/README.md @@ -280,7 +280,12 @@ You can run your application as a remote debuggee and the remote debugger consol ### Invoke as a remote debuggee -There are two ways to invoke a script as remote debuggee: Use `rdbg --open` and require `debug/open` (or `debug/open_nonstop`). +There are multiple ways to run your program as a debuggee: + +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) +---|---|---|---| +Yes | `rdbg --open` | `require "debug/open"` | `DEBUGGER__.open` +No | `rdbg --open --nonstop` | `require "debug/open_nonstop"` | `DEBUGGER__.open(nonstop: true)` #### `rdbg --open` (or `rdbg -O` for short) diff --git a/misc/README.md.erb b/misc/README.md.erb index 101666d94..65e405340 100644 --- a/misc/README.md.erb +++ b/misc/README.md.erb @@ -280,7 +280,12 @@ You can run your application as a remote debuggee and the remote debugger consol ### Invoke as a remote debuggee -There are two ways to invoke a script as remote debuggee: Use `rdbg --open` and require `debug/open` (or `debug/open_nonstop`). +There are multiple ways to run your program as a debuggee: + +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) +---|---|---|---| +Yes | `rdbg --open` | `require "debug/open"` | `DEBUGGER__.open` +No | `rdbg --open --nonstop` | `require "debug/open_nonstop"` | `DEBUGGER__.open(nonstop: true)` #### `rdbg --open` (or `rdbg -O` for short)