Skip to content

Commit 654e6ec

Browse files
xegerko1
authored andcommitted
Add warning about legacy debug gem
1 parent 3a728f5 commit 654e6ec

File tree

2 files changed

+10
-4
lines changed

2 files changed

+10
-4
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,9 @@ If you use Bundler, write the following line to your Gemfile.
3838
gem "debug", ">= 1.0.0"
3939
```
4040

41+
(The version constraint is important; `debug < 1.0.0` is an older,
42+
abandoned gem that is completely different from this product.)
43+
4144
# HOW TO USE
4245

4346
To use a debugger, roughly you will do the following steps:
@@ -134,7 +137,7 @@ d => 4
134137
### Invoke the program from the debugger as a traditional debuggers
135138

136139
If you don't want to modify the source code, you can set breakpoints with a debug command `break` (`b` for short).
137-
Using `rdbg` command to launch the program without any modifications, you can run the program with the debugger.
140+
Using `rdbg` command (or `bundle exec rdbg`) to launch the program without any modifications, you can run the program with the debugger.
138141

139142
```shell
140143
$ cat target.rb # Sample program
@@ -285,7 +288,7 @@ There are multiple ways to run your program as a debuggee:
285288
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)
286289
---|---|---|---|
287290
Yes | `rdbg --open` | `require "debug/open"` | `DEBUGGER__.open`
288-
No | `rdbg --open --nonstop` | `require "debug/open_nonstop"` | `DEBUGGER__.open(nonstop: true)`
291+
No | `rdbg --open --nonstop` | `require "debug/open_nonstop"` | `DEBUGGER__.open(nonstop: true)`
289292

290293
#### `rdbg --open` (or `rdbg -O` for short)
291294

misc/README.md.erb

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,9 @@ If you use Bundler, write the following line to your Gemfile.
3838
gem "debug", ">= 1.0.0"
3939
```
4040

41+
(The version constraint is important; `debug < 1.0.0` is an older,
42+
abandoned gem that is completely different from this product.)
43+
4144
# HOW TO USE
4245

4346
To use a debugger, roughly you will do the following steps:
@@ -134,7 +137,7 @@ d => 4
134137
### Invoke the program from the debugger as a traditional debuggers
135138

136139
If you don't want to modify the source code, you can set breakpoints with a debug command `break` (`b` for short).
137-
Using `rdbg` command to launch the program without any modifications, you can run the program with the debugger.
140+
Using `rdbg` command (or `bundle exec rdbg`) to launch the program without any modifications, you can run the program with the debugger.
138141

139142
```shell
140143
$ cat target.rb # Sample program
@@ -285,7 +288,7 @@ There are multiple ways to run your program as a debuggee:
285288
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)
286289
---|---|---|---|
287290
Yes | `rdbg --open` | `require "debug/open"` | `DEBUGGER__.open`
288-
No | `rdbg --open --nonstop` | `require "debug/open_nonstop"` | `DEBUGGER__.open(nonstop: true)`
291+
No | `rdbg --open --nonstop` | `require "debug/open_nonstop"` | `DEBUGGER__.open(nonstop: true)`
289292

290293
#### `rdbg --open` (or `rdbg -O` for short)
291294

0 commit comments

Comments
 (0)