debug 1.6.1 → 1.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78f83c7a7b44c3cae68d784d70fd653410ebce976c02bf846a9992f102634d98
-  data.tar.gz: b34c3d6b060aa20db1794905aef969105070d556862ceac4cf02ccc88db9bf0a
+  metadata.gz: cbc923d5ce88d6092dbc8125ee988ec386fffdc3409b8bca4113ab925bc61311
+  data.tar.gz: 2e0a5013263c3c220dfee989af1a87c224f36bf03504fef120785717df5b9ef7
 SHA512:
-  metadata.gz: c408ae087cd00a03e53410a9f6c3c54e2e4536d41784fb109dedd278d8b7941182a925593bf34991bfc2c15ed43e7baa20c736bde0aecb72b832fbdb4f4b55fe
-  data.tar.gz: b223e415ae539a0b95303b065f029afe48cd2007697979d66ca94e157d7823b848ffd40c1ccc5e2947d69a8aa1c23c08961ade262bc6315f267ec73176c2d882
+  metadata.gz: eb62ffd4d8111449f618b8a91a4ab9b89237916eeb71e0fd57dd1d78d4ddadff4a3897cbdf989cd989b9c0a52103f8bfd02f1e6cd9d2453b70bd72025f1b63aa
+  data.tar.gz: 81607797fa369d2eeed0fe35335d078ea04be3ab653dea8b653b0c25453c2000407a532c17246d41be175f1df34d7bebc069deb83fef976b39a79df2a399b79c

data/CONTRIBUTING.md

@@ -149,10 +149,10 @@ If the file already exists, **only method** will be added to it.
 ```ruby
 # frozen_string_literal: true
 
-require_relative '../support/test_case'
+require_relative '../support/console_test_case'
 
 module DEBUGGER__
-  class FooTest < TestCase
+  class FooTest < ConsoleTestCase
     def program
       <<~RUBY
         1| module Foo
@@ -166,7 +166,7 @@ module DEBUGGER__
         9| end
       RUBY
     end
-    
+
     def test_1629720194
       debug_code(program) do
         type 's'
@@ -269,10 +269,10 @@ Currently, there are 2 kinds of test frameworks for DAP and CDP.
 
 If you want to write protocol-based tests, you should use the test generator.
 To run the test generator, you can enter `$ bin/gentest target.rb --open=vscode` in the terminal, VSCode will be executed.
-Also, if you enter ``$ bin/gentest target.rb --open=chrome` there, Chrome will be executed.
+Also, if you enter `$ bin/gentest target.rb --open=chrome` there, Chrome will be executed.
 If you need to modify existing tests, it is basically a good idea to regenerate them by the test generator instead of rewriting them directly.
 Please refer to [the Microsoft "Debug Adapter Protocol" article](https://microsoft.github.io/debug-adapter-protocol/specification) to learn more about DAP formats.
-Please refer to [Procol viewer for "Chrome DevTools Protocol"](https://chromedevtools.github.io/devtools-protocol/) to learn more about CDP formats.
+Please refer to [the "Chrome DevTools Protocol" official documentation](https://chromedevtools.github.io/devtools-protocol/) to learn more about CDP formats.
 
 2. High-level tests
 
@@ -320,6 +320,22 @@ Execute debugging `program` with `&scenario`. If you want to test it only for DA
 
 `run_protocol_scenario program, cdp: false ...`
 
+- attach_to_dap_server(terminate_debuggee:)
+
+Attach to the running DAP server through UNIX Domain Socket.
+
+- attach_to_cdp_server
+
+Attach to the running CDP server through TCP/IP.
+
+- req_dap_disconnect
+
+Disconnect from the currently connected DAP server.
+
+- req_cdp_disconnect
+
+Disconnect from the currently connected CDP server.
+
 - req_add_breakpoint(lineno, path: temp_file_path, cond: nil)
 
 Sends request to rdbg to add a breakpoint.
@@ -336,7 +352,7 @@ Sends request to rdbg to set exception breakpoints. e.g.
 req_set_exception_breakpoints([{ name: "RuntimeError", condition: "a == 1" }])
 ```
 
-Please note that `setExceptionBreakpoints` resets all exception breakpoints in every request. 
+Please note that `setExceptionBreakpoints` resets all exception breakpoints in every request.
 
 So the following code will only set breakpoint for `Exception`.
 
@@ -377,10 +393,6 @@ Sends request to rdbg to step back from current method.
 
 Sends request to rdbg to terminate the debuggee.
 
-- assert_reattach
-
-Passes if reattaching to rdbg is successful.
-
 - assert_hover_result(expected, expression)
 
 Passes if result of `expression` matches `expected`.

data/README.md

@@ -2,9 +2,9 @@
 
 # debug.rb
 
-This library provides debugging functionality to Ruby (MRI) 2.6 and later.
+This library provides debugging functionality to Ruby (MRI) 2.7 and later.
 
-This debug.rb is replacement of traditional lib/debug.rb standard library which is implemented by `set_trace_func`.
+This debug.rb is the replacement of traditional lib/debug.rb standard library, which is implemented by `set_trace_func`.
 New debug.rb has several advantages:
 
 * Fast: No performance penalty on non-stepping mode and non-breakpoints.
@@ -18,7 +18,7 @@ New debug.rb has several advantages:
      Connection | UDS, TCP/IP | UDS, TCP/IP | TCP/IP |
      Requirement | No | [vscode-rdbg](https://marketplace.visualstudio.com/items?itemName=KoichiSasada.vscode-rdbg) | Chrome |
 
-* Extensible: application can introduce debugging support with several ways:
+* Extensible: application can introduce debugging support in several ways:
   * By `rdbg` command
   * By loading libraries with `-r` command line option
   * By calling Ruby's method explicitly
@@ -26,7 +26,7 @@ New debug.rb has several advantages:
   * Support threads (almost done) and ractors (TODO).
   * Support suspending and entering to the console debugging with `Ctrl-C` at most of timing.
   * Show parameters on backtrace command.
-  * Support recording & reply debugging.
+  * Support recording & replay debugging.
 
 # Installation
 
@@ -55,7 +55,7 @@ To use a debugger, roughly you will do the following steps:
 4. Use debug commands.
     * [Evaluate Ruby expressions](#evaluate) (e.g. `p lvar` to see the local variable `lvar`).
     * [Query the program status](#information) (e.g. `info` to see information about the current frame).
-    * [Control program flow](#control-flow) (e.g. move to the another line with `step`, to the next line with `next`).
+    * [Control program flow](#control-flow) (e.g. move to another line with `step`, to the next line with `next`).
     * [Set another breakpoint](#breakpoint) (e.g. `catch Exception` to set a breakpoint that'll be triggered when `Exception` is raised).
     * [Activate tracing in your program](#trace) (e.g. `trace call` to trace method calls).
     * [Change the configuration](#configuration-1) (e.g. `config set no_color true` to disable coloring).
@@ -180,7 +180,7 @@ DEBUGGER: Session start (pid: 7656)
 #1  BP - Line  /mnt/c/ko1/src/rb/ruby-debug/target.rb:5 (line)
 ```
 
-You can see that two breakpoints are registered. Let's continue the program by `continue` command.
+You can see that two breakpoints are registered. Let's continue the program by using the `continue` command.
 
 ```shell
 (rdbg) continue
@@ -200,8 +200,8 @@ Stop by #0  BP - Line  /mnt/c/ko1/src/rb/ruby-debug/target.rb:3 (line)
 ```
 
 You can see that we can stop at line 3.
-Let's see the local variables with `info` command, and continue.
-You can also confirm that the program will suspend at line 5 and you can use `info` command again.
+Let's see the local variables with the `info` command, and continue.
+You can also confirm that the program will suspend at line 5 and you can use the `info` command again.
 
 ```shell
 (rdbg) info
@@ -238,14 +238,14 @@ d => 4
 ```
 
 By the way, using `rdbg` command you can suspend your application with `C-c` (SIGINT) and enter the debug console.
-It will help that if you want to know what the program is doing.
+It will help if you want to know what the program is doing.
 
 ### Use `rdbg` with commands written in Ruby
 
-If you want to run a command written in Ruby like like `rake`, `rails`, `bundle`, `rspec` and so on, you can use `rdbg -c` option.
+If you want to run a command written in Ruby like `rake`, `rails`, `bundle`, `rspec`, and so on, you can use `rdbg -c` option.
 
 * Without `-c` option, `rdbg <name>` means that `<name>` is Ruby script and invoke it like `ruby <name>` with the debugger.
-* With `-c` option, `rdbg -c <name>` means that `<name>` is command in `PATH` and simply invoke it with the debugger.
+* With `-c` option, `rdbg -c <name>` means that `<name>` is a command in `PATH` and simply invokes it with the debugger.
 
 Examples:
 * `rdbg -c -- rails server`
@@ -263,27 +263,27 @@ Like other languages, you can use this debugger on the VSCode.
 
 1. Install [VSCode rdbg Ruby Debugger - Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=KoichiSasada.vscode-rdbg)
 2. Open `.rb` file (e.g. `target.rb`)
-3. Register breakpoints with "Toggle breakpoint" in Run menu (or type F9 key)
+3. Register breakpoints with "Toggle breakpoint" in the Run menu (or type F9 key)
 4. Choose "Start debugging" in "Run" menu (or type F5 key)
-5. You will see a dialog "Debug command line" and you can choose your favorite command line your want to run.
-6. Chosen command line is invoked with `rdbg -c` and VSCode shows the details at breakpoints.
+5. You will see a dialog "Debug command line" and you can choose your favorite command line you want to run.
+6. Chosen command line is invoked with `rdbg -c`, and VSCode shows the details at breakpoints.
 
-Please refer [Debugging in Visual Studio Code](https://code.visualstudio.com/docs/editor/debugging) for operations on VSCode.
+Please refer to [Debugging in Visual Studio Code](https://code.visualstudio.com/docs/editor/debugging) for operations on VSCode.
 
 You can configure the extension in `.vscode/launch.json`.
 Please see the extension page for more details.
 
 ## Remote debugging
 
-You can use this debugger as a remote debugger. For example, it will help the following situations:
+You can use this debugger as a remote debugger. For example, it will help in the following situations:
 
-* Your application does not run on TTY and it is hard to use `binding.pry` or `binding.irb`.
-  * Your application is running on Docker container and there is no TTY.
+* Your application does not run on TTY, and it is hard to use `binding.pry` or `binding.irb`.
+  * Your application is running on a Docker container, and there is no TTY.
   * Your application is running as a daemon.
   * Your application uses pipe for STDIN or STDOUT.
 * Your application is running as a daemon and you want to query the running status (checking a backtrace and so on).
 
-You can run your application as a remote debuggee and the remote debugger console can attach to the debuggee anytime.
+You can run your application as a remote debuggee, and the remote debugger console can attach to the debuggee anytime.
 
 ### Invoke as a remote debuggee
 
@@ -305,7 +305,7 @@ DEBUGGER: Debugger can attach via UNIX domain socket (/home/ko1/.ruby-debug-sock
 DEBUGGER: wait for debugger connection...
 ```
 
-By default, `rdbg --open` uses UNIX domain socket and generates path name automatically (`/home/ko1/.ruby-debug-sock/ruby-debug-ko1-7773` in this case).
+By default, `rdbg --open` uses UNIX domain socket and generates the path name automatically (`/home/ko1/.ruby-debug-sock/ruby-debug-ko1-7773` in this case).
 
 You can connect to the debuggee with `rdbg --attach` command (`rdbg -A` for short).
 
@@ -324,11 +324,11 @@ $ rdbg -A
 (rdbg:remote)
 ```
 
-If there is no other opening ports on the default directory, `rdbg --attach` command chooses the only one opening UNIX domain socket and connect to it. If there are more files, you need to specify the file.
+If there are no other opening ports on the default directory, `rdbg --attach` command chooses the only one opening UNIX domain socket and connects to it. If there are more files, you need to specify the file.
 
-When `rdbg --attach` connects to the debuggee, you can use any debug commands (set breakpoints, continue the program and so on) like local debug console. When an debuggee program exits, the remote console will also terminate.
+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. When a debuggee program exits, the remote console will also terminate.
 
-NOTE: If you use `quit` command, only remote console exits and the debuggee program continues to run (and you can connect it again). If you want to exit the debuggee program, use `kill` command.
+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). If you want to exit the debuggee program, use `kill` command.
 
 If you want to use TCP/IP for the remote debugging, you need to specify the port and host with `--port` like `rdbg --open --port 12345` and it binds to `localhost:12345`.
 
@@ -343,11 +343,11 @@ Note that all messages communicated between the debugger and the debuggee are *N
 
 #### `require 'debug/open'` in a program
 
-If you can modify the program, you can open debugging port by adding `require 'debug/open'` line in the program.
+If you can modify the program, you can open the debugging port by adding `require 'debug/open'` line in the program.
 
 If you don't want to stop the program at the beginning, you can also use `require 'debug/open_nonstop'`.
 Using `debug/open_nonstop` is useful if you want to open a backdoor to the application.
-However, it is also danger because it can become another vulnerability.
+However, it is also dangerous because it can become another vulnerability.
 Please use it carefully.
 
 By default, UNIX domain socket is used for the debugging port. To use TCP/IP, you can set the `RUBY_DEBUG_PORT` environment variable.
@@ -372,7 +372,7 @@ Also `open` command allows opening the debug port.
 
 ([vscode-rdbg v0.0.9](https://marketplace.visualstudio.com/items?itemName=KoichiSasada.vscode-rdbg) or later is required)
 
-If you don't run a debuggee Ruby process on VSCode, you can attach with VSCode later with the following steps.
+If you don't run a debuggee Ruby process on VSCode, you can attach it to VSCode later with the following steps.
 
 `rdbg --open=vscode` opens the debug port and tries to invoke the VSCode (`code` command).
 
@@ -425,7 +425,7 @@ If your application is running on a SSH remote host, please try:
 
 ```
 
-and try to use proposed commands.
+and try to use the proposed commands.
 
 Note that you can attach with `rdbg --attach` and continue REPL debugging.
 
@@ -438,12 +438,12 @@ $ rdbg target.rb --open=chrome
 DEBUGGER: Debugger can attach via TCP/IP (127.0.0.1:43633)
 DEBUGGER: With Chrome browser, type the following URL in the address-bar:
 
-   devtools://devtools/bundled/inspector.html?ws=127.0.0.1:43633
+   devtools://devtools/bundled/inspector.html?v8only=true&panel=sources&ws=127.0.0.1:57231/b32a55cd-2eb5-4c5c-87d8-b3dfc59d80ef
 
 DEBUGGER: wait for debugger connection...
 ```
 
-Type `devtools://devtools/bundled/inspector.html?ws=127.0.0.1:43633` in the address-bar on Chrome browser, and you can continue the debugging with chrome browser.
+Type `devtools://devtools/bundled/inspector.html?v8only=true&panel=sources&ws=127.0.0.1:57231/b32a55cd-2eb5-4c5c-87d8-b3dfc59d80ef` in the address bar on Chrome browser, and you can continue the debugging with chrome browser.
 
 Also `open chrome` command works like `open vscode`.
 
@@ -456,7 +456,7 @@ When the debug session is started, initial scripts are loaded so you can put you
 
 ### Configuration list
 
-You can configure debugger's behavior with environment variables and `config` command. Each configuration has environment variable and the name which can be specified by `config` command.
+You can configure the debugger's behavior with environment variables and `config` command. Each configuration has an environment variable and a name which can be specified by `config` command.
 
 ```
 # configuration example
@@ -469,12 +469,15 @@ config set no_color true
 * UI
   * `RUBY_DEBUG_LOG_LEVEL` (`log_level`): Log level same as Logger (default: WARN)
   * `RUBY_DEBUG_SHOW_SRC_LINES` (`show_src_lines`): Show n lines source code on breakpoint (default: 10)
+  * `RUBY_DEBUG_SHOW_EVALEDSRC` (`show_evaledsrc`): Show actually evaluated source (default: false)
   * `RUBY_DEBUG_SHOW_FRAMES` (`show_frames`): Show n frames on breakpoint (default: 2)
   * `RUBY_DEBUG_USE_SHORT_PATH` (`use_short_path`): Show shorten PATH (like $(Gem)/foo.rb) (default: false)
   * `RUBY_DEBUG_NO_COLOR` (`no_color`): Do not use colorize (default: false)
   * `RUBY_DEBUG_NO_SIGINT_HOOK` (`no_sigint_hook`): Do not suspend on SIGINT (default: false)
   * `RUBY_DEBUG_NO_RELINE` (`no_reline`): Do not use Reline library (default: false)
   * `RUBY_DEBUG_NO_HINT` (`no_hint`): Do not show the hint on the REPL (default: false)
+  * `RUBY_DEBUG_NO_LINENO` (`no_lineno`): Do not show line numbers (default: false)
+  * `RUBY_DEBUG_IRB_CONSOLE` (`irb_console`): Use IRB as the console (default: false)
 
 * CONTROL
   * `RUBY_DEBUG_SKIP_PATH` (`skip_path`): Skip showing/entering frames for given paths
@@ -488,12 +491,13 @@ config set no_color true
   * `RUBY_DEBUG_NONSTOP` (`nonstop`): Nonstop mode (default: false)
   * `RUBY_DEBUG_STOP_AT_LOAD` (`stop_at_load`): Stop at just loading location (default: false)
   * `RUBY_DEBUG_INIT_SCRIPT` (`init_script`): debug command script path loaded at first stop
-  * `RUBY_DEBUG_COMMANDS` (`commands`): debug commands invoked at first stop. commands should be separated by ';;'
+  * `RUBY_DEBUG_COMMANDS` (`commands`): debug commands invoked at first stop. Commands should be separated by `;;`
   * `RUBY_DEBUG_NO_RC` (`no_rc`): ignore loading ~/.rdbgrc(.rb) (default: false)
   * `RUBY_DEBUG_HISTORY_FILE` (`history_file`): history file (default: ~/.rdbg_history)
   * `RUBY_DEBUG_SAVE_HISTORY` (`save_history`): maximum save history lines (default: 10000)
 
 * REMOTE
+  * `RUBY_DEBUG_OPEN` (`open`): Open remote port (same as `rdbg --open` option)
   * `RUBY_DEBUG_PORT` (`port`): TCP/IP remote debugging: port
   * `RUBY_DEBUG_HOST` (`host`): TCP/IP remote debugging: host (default: 127.0.0.1)
   * `RUBY_DEBUG_SOCK_PATH` (`sock_path`): UNIX Domain Socket remote debugging: socket path
@@ -501,7 +505,7 @@ config set no_color true
   * `RUBY_DEBUG_LOCAL_FS_MAP` (`local_fs_map`): Specify local fs map
   * `RUBY_DEBUG_SKIP_BP` (`skip_bp`): Skip breakpoints if no clients are attached (default: false)
   * `RUBY_DEBUG_COOKIE` (`cookie`): Cookie for negotiation
-  * `RUBY_DEBUG_OPEN_FRONTEND` (`open_frontend`): frontend used by open command (vscode, chrome, default: rdbg).
+  * `RUBY_DEBUG_SESSION_NAME` (`session_name`): Session name for differentiating multiple sessions
   * `RUBY_DEBUG_CHROME_PATH` (`chrome_path`): Platform dependent path of Chrome (For more information, See [here](https://github.com/ruby/debug/pull/334/files#diff-5fc3d0a901379a95bc111b86cf0090b03f857edfd0b99a0c1537e26735698453R55-R64))
 
 * OBSOLETE
@@ -511,7 +515,7 @@ There are other environment variables:
 
 * `NO_COLOR`: If the value is set, set `RUBY_DEBUG_NO_COLOR` ([NO_COLOR: disabling ANSI color output in various Unix commands](https://no-color.org/)).
 * `RUBY_DEBUG_ENABLE`: If the value is `0`, do not enable debug.gem feature.
-* `RUBY_DEBUG_ADDED_RUBYOPT`: Remove this value from `RUBYOPT` at first. This feature helps loading debug.gem with `RUBYOPT='-r debug/...'` and you don't want to derive it to child processes. In this case you can set `RUBY_DEBUG_ADDED_RUBYOPT='-r debug/...'` (same value) and this string will be deleted from `RUBYOPT` at first.
+* `RUBY_DEBUG_ADDED_RUBYOPT`: Remove this value from `RUBYOPT` at first. This feature helps loading debug.gem with `RUBYOPT='-r debug/...'`, and you don't want to derive it to child processes. In this case, you can set `RUBY_DEBUG_ADDED_RUBYOPT='-r debug/...'` (same value), and this string will be deleted from `RUBYOPT` at first.
 * `RUBY_DEBUG_EDITOR` or `EDITOR`: An editor used by `edit` debug command.
 * `RUBY_DEBUG_BB`: Define `Kernel#bb` method which is alias of `Kernel#debugger`.
 
@@ -523,7 +527,7 @@ If there is `~/.rdbgrc`, the file is loaded as an initial script (which contains
 * You can specify the initial script with `rdbg -x initial_script` (like gdb's `-x` option).
 
 Initial scripts are useful to write your favorite configurations.
-For example, you can set break points with `break file:123` in `~/.rdbgrc`.
+For example, you can set breakpoints with `break file:123` in `~/.rdbgrc`.
 
 If there are `~/.rdbgrc.rb` is available, it is also loaded as a ruby script at same timing.
 
@@ -533,15 +537,16 @@ On the debug console, you can use the following debug commands.
 
 There are additional features:
 
-* `<expr>` without debug command is almost same as `pp <expr>`.
-  * 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. So that the input `foo.bar` is same as `pp foo.bar`.
-  * If `<expr>` is recognized as a debug command, of course it is not evaluated as a Ruby expression, but is executed as debug command. 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.
-* `Enter` without any input repeats the last command (useful when repeating `step`s).
+* `<expr>` without debug command is almost the same as `pp <expr>`.
+  * 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. So that the input `foo.bar` is the same as `pp foo.bar`.
+  * If `<expr>` is recognized as a debug command, of course, it is not evaluated as a Ruby expression but is executed as debug command. 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.
+  * So the author (Koichi Sasada) recommends using `p`, `pp` or `eval` command to evaluate the Ruby expression every time.
+* `Enter` without any input repeats the last command (useful when repeating `step`s) for some commands.
 * `Ctrl-D` is equal to `quit` command.
 * [debug command compare sheet - Google Sheets](https://docs.google.com/spreadsheets/d/1TlmmUDsvwK4sSIyoMv-io52BUUz__R5wpu-ComXlsw0/edit?usp=sharing)
 
 You can use the following debug commands. Each command should be written in 1 line.
-The `[...]` notation means this part can be eliminate. For example, `s[tep]` means `s` or `step` are valid command. `ste` is not valid.
+The `[...]` notation means this part can be eliminated. For example, `s[tep]` means `s` or `step` is a valid command. `ste` is not valid.
 The `<...>` notation means the argument.
 
 ### Control flow
@@ -558,7 +563,14 @@ The `<...>` notation means the argument.
   * Finish this frame. Resume the program until the current frame is finished.
 * `fin[ish] <n>`
   * Finish `<n>`th frames.
-* `c[ontinue]`
+* `u[ntil]`
+  * Similar to `next` command, but only stop later lines or the end of the current frame.
+  * Similar to gdb's `advance` command.
+* `u[ntil] <[file:]line>`
+  * Run til the program reaches given location or the end of the current frame.
+* `u[ntil] <name>`
+  * Run til the program invokes a method `<name>`. `<name>` can be a regexp with `/name/`.
+* `c` or `cont` or `continue`
   * Resume the program.
 * `q[uit]` or `Ctrl-D`
   * Finish debugger (with the debuggee process on non-remote debugging).
@@ -638,26 +650,35 @@ The `<...>` notation means the argument.
   * Show predecessor lines as opposed to the `list` command.
 * `l[ist] <start>` or `l[ist] <start>-<end>`
   * Show current frame's source code from the line <start> to <end> if given.
+* `whereami`
+  * Show the current frame with source code.
 * `edit`
   * Open the current file on the editor (use `EDITOR` environment variable).
   * Note that edited file will not be reloaded.
 * `edit <file>`
   * Open <file> on the editor.
 * `i[nfo]`
-   * Show information about current frame (local/instance variables and defined constants).
-* `i[nfo] l[ocal[s]]`
+  * Show information about current frame (local/instance variables and defined constants).
+* `i[nfo]` <subcommand>
+  * `info` has the following sub-commands.
+  * Sub-commands can be specified with few letters which is unambiguous, like `l` for 'locals'.
+* `i[nfo] l or locals or local_variables`
   * Show information about the current frame (local variables)
-  * It includes `self` as `%self` and a return value as `%return`.
-* `i[nfo] i[var[s]]` or `i[nfo] instance`
+  * It includes `self` as `%self` and a return value as `_return`.
+* `i[nfo] i or ivars or instance_variables`
   * Show information about instance variables about `self`.
-* `i[nfo] c[onst[s]]` or `i[nfo] constant[s]`
+  * `info ivars <expr>` shows the instance variables of the result of `<expr>`.
+* `i[nfo] c or consts or constants`
   * Show information about accessible constants except toplevel constants.
-* `i[nfo] g[lobal[s]]`
+  * `info consts <expr>` shows the constants of a class/module of the result of `<expr>`
+* `i[nfo] g or globals or global_variables`
   * Show information about global variables
+* `i[nfo] th or threads`
+  * Show all threads (same as `th[read]`).
+* `i[nfo] b or breakpoints or w or watchpoints`
+  * Show all breakpoints and watchpoints.
 * `i[nfo] ... /regexp/`
   * Filter the output with `/regexp/`.
-* `i[nfo] th[read[s]]`
-  * Show all threads (same as `th[read]`).
 * `o[utline]` or `ls`
   * Show you available methods, constants, local variables, and instance variables in the current scope.
 * `o[utline] <expr>` or `ls <expr>`
@@ -795,7 +816,7 @@ Emacs support available.
 
 #### Start by method
 
-After loading `debug/session`, you can start debug session with the following methods. They are convenient if you want to specify debug configurations in your program.
+After loading `debug/session`, you can start a debug session with the following methods. They are convenient if you want to specify debug configurations in your program.
 
 * `DEBUGGER__.start(**kw)`: start debug session with local console.
 * `DEBUGGER__.open(**kw)`: open debug port with configuration (without configurations open with UNIX domain socket)
@@ -814,21 +835,21 @@ DEBUGGER__.start(no_color: true,    # disable colorize
 
 ### `binding.break` method
 
-`binding.break` (or `binding.b`) set breakpoints at written line. It also has several keywords.
+`binding.break` (or `binding.b`) set breakpoints at the written line. It also has several keywords.
 
-If `do: 'command'` is specified, the debugger suspends the program and run the `command` as a debug command and continue the program.
+If `do: 'command'` is specified, the debugger suspends the program, runs the `command` as a debug command, and continues the program.
 It is useful if you only want to call a debug command and don't want to stop there.
 
 ```
 def initialize
   @a = 1
-  binding.b do: 'watch @a'
+  binding.b do: 'info \n watch @a'
 end
 ```
 
-On this case, register a watch breakpoint for `@a` and continue to run.
+In this case, execute the `info` command then register a watch breakpoint for `@a` and continue to run. You can also use `;;` instead of `\n` to separate your commands.
 
-If `pre: 'command'` is specified, the debugger suspends the program and run the `command` as a debug command, and keep suspend.
+If `pre: 'command'` is specified, the debugger suspends the program and runs the `command` as a debug command, and keeps suspended.
 It is useful if you have operations before suspend.
 
 ```
@@ -838,7 +859,7 @@ def foo
 end
 ```
 
-On this case, you can see the result of `bar()` every time you stop there.
+In this case, you can see the result of `bar()` every time you stop there.
 
 ## rdbg command help
 
@@ -864,6 +885,7 @@ Debug console mode:
         --port=PORT                  Listening TCP/IP port
         --host=HOST                  Listening TCP/IP host
         --cookie=COOKIE              Set a cookie for connection
+        --session-name=NAME          Session name
 
   Debug console mode runs Ruby program with the debug console.
 
@@ -890,6 +912,8 @@ Attach mode:
   'rdbg -A host port' tries to connect to host:port via TCP/IP.
 
 Other options:
+    -v                               Show version number
+        --version                    Show version number and exit
     -h, --help                       Print help
         --util=NAME                  Utility mode (used by tools)
         --stop-at-load               Stop immediately when the debugging feature is loaded.
@@ -900,6 +924,11 @@ NOTE
 
 ```
 
+# Additional Resources
+
+- [From byebug to ruby/debug](https://st0012.dev/from-byebug-to-ruby-debug) by Stan Lo - A migration guide for `byebug` users.
+- [ruby/debug cheatsheet](https://st0012.dev/ruby-debug-cheatsheet) by Stan Lo
+
 # Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/debug.

data/Rakefile

@@ -35,9 +35,14 @@ task :check_readme do
   end
 end
 
+desc "Run debug.gem test-framework tests"
+Rake::TestTask.new(:test_test) do |t|
+  t.test_files = FileList["test/support/*_test.rb"]
+end
+
 desc "Run all debugger console related tests"
 Rake::TestTask.new(:test_console) do |t|
-  t.test_files = FileList["test/console/*_test.rb", "test/support/*_test.rb"]
+  t.test_files = FileList["test/console/*_test.rb"]
 end
 
 desc "Run all debugger protocols (CAP & DAP) related tests"
@@ -46,7 +51,7 @@ Rake::TestTask.new(:test_protocol) do |t|
 end
 
 task test: 'test_console' do
-  warn '`rake test` doesn\'t run protocol tests. Use `rake test-all` to test all.'
+  warn '`rake test` doesn\'t run protocol tests. Use `rake test_all` to test all.'
 end
 
-task test_all: [:test_console, :test_protocol]
+task test_all: [:test_test, :test_console, :test_protocol]

data/TODO.md

@@ -2,22 +2,22 @@
 
 ## Basic functionality
 
-* Support Ractors
-* Signal (SIGINT) trap handling 
+* Support Fibers and Ractors
 
 ## UI
 
+* Multi-line support
 * Completion for Ruby's code
 * Interactive breakpoint setting
 * Interactive record & play debugging
 * irb integration
-* Web browser integrated UI
-* History file
 
 ## Debug command
 
-* Breakpoints
-    * Lightweight pending method break points with Ruby 3.1 feature (TP:method_added)
 * Watch points
-    * Lightweight watchpoints for instance variables with Ruby 3.1 features (TP:ivar_set)
-* Faster `next`/`finish` command by specifying target code.
+    * Lightweight watchpoints for instance variables with Ruby 3.3 features (TP:ivar_set)
+* Alias
+
+## Debug port
+
+* Debug port for monitoring

data/debug.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.description   = %q{Debugging functionality for Ruby. This is completely rewritten debug.rb which was contained by the ancient Ruby versions.}
   spec.homepage      = "https://github.com/ruby/debug"
   spec.licenses      = ["Ruby", "BSD-2-Clause"]
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
@@ -27,6 +27,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.extensions    = ['ext/debug/extconf.rb']
 
-  spec.add_dependency "irb", ">= 1.3.6" # for its color_printer class, which was added after 1.3
-  spec.add_dependency "reline", ">= 0.3.1"
+  spec.add_dependency "irb", "~> 1.10" # for irb:debug integration
+  spec.add_dependency "reline", ">= 0.3.8"
 end

data/exe/rdbg

@@ -10,13 +10,28 @@ when :start
   require 'rbconfig'
 
   libpath = File.join(File.expand_path(File.dirname(__dir__)), 'lib/debug')
-  start_mode = config[:remote] ? "open" : 'start'
+  start_mode = config[:open] ? "open" : 'start'
   cmd = config[:command] ? ARGV.shift : (ENV['RUBY'] || RbConfig.ruby)
 
+  if defined?($:.resolve_feature_path)
+    begin
+      _, sopath = $:.resolve_feature_path('debug/debug.so')
+    rescue LoadError
+      # raises LoadError before 3.1 (2.7 and 3.0)
+    else
+      sopath = File.dirname(File.dirname(sopath)) if sopath
+    end
+  else
+    # `$:.resolve_feature_path` is not defined in 2.6 or earlier.
+    so = "debug/debug.#{RbConfig::CONFIG['DLEXT']}"
+    sopath = $:.find {|dir| File.exist?(File.join(dir, so))}
+  end
+  added = "-r #{libpath}/#{start_mode}"
+  added = "-I #{sopath} #{added}" if sopath
+  rubyopt = ENV['RUBYOPT']
   env = ::DEBUGGER__::Config.config_to_env_hash(config)
-  rubyopt = env['RUBYOPT']
-  env['RUBY_DEBUG_ADDED_RUBYOPT'] = added = "-r #{libpath}/#{start_mode}"
-  env['RUBYOPT'] = "#{added} #{rubyopt}"
+  env['RUBY_DEBUG_ADDED_RUBYOPT'] = added
+  env['RUBYOPT'] = "#{rubyopt} #{added}"
 
   exec(env, cmd, *ARGV)