From ba8f37e9c8d544aa0634a788955dc8eb0f5a6cc6 Mon Sep 17 00:00:00 2001 From: Stan Lo Date: Sun, 10 Apr 2022 06:19:14 +0800 Subject: [PATCH] Add supported interfaces table --- README.md | 13 +++++++++---- misc/README.md.erb | 12 ++++++++---- 2 files changed, 17 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index b69c063db..83c3fa90f 100644 --- a/README.md +++ b/README.md @@ -9,11 +9,15 @@ New debug.rb has several advantages: * Fast: No performance penalty on non-stepping mode and non-breakpoints. * [Remote debugging](#remote-debugging): Support remote debugging natively. - * UNIX domain socket + * UNIX domain socket (UDS) * TCP/IP - * Integration with rich debugger frontend - * VSCode/DAP ([VSCode rdbg Ruby Debugger - Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=KoichiSasada.vscode-rdbg)) - * Chrome DevTools + * Integration with rich debugger frontends + + 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) | + ---|---|---|---| + Connection | UDS, TCP/IP | UDS, TCP/IP | TCP/IP | + Requirement | No | [vscode-rdbg](https://marketplace.visualstudio.com/items?itemName=KoichiSasada.vscode-rdbg) | No | + * Extensible: application can introduce debugging support with several ways: * By `rdbg` command * By loading libraries with `-r` command line option @@ -493,6 +497,7 @@ config set no_color true * `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 * `RUBY_DEBUG_SOCK_DIR` (`sock_dir`): UNIX Domain Socket remote debugging: socket directory + * `RUBY_DEBUG_LOCAL_FS_MAP` (`local_fs_map`): Specify local fs map * `RUBY_DEBUG_COOKIE` (`cookie`): Cookie for negotiation * `RUBY_DEBUG_OPEN_FRONTEND` (`open_frontend`): frontend used by open command (vscode, chrome, default: rdbg). * `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)) diff --git a/misc/README.md.erb b/misc/README.md.erb index 62b3b655f..59b1cb0e9 100644 --- a/misc/README.md.erb +++ b/misc/README.md.erb @@ -9,11 +9,15 @@ New debug.rb has several advantages: * Fast: No performance penalty on non-stepping mode and non-breakpoints. * [Remote debugging](#remote-debugging): Support remote debugging natively. - * UNIX domain socket + * UNIX domain socket (UDS) * TCP/IP - * Integration with rich debugger frontend - * VSCode/DAP ([VSCode rdbg Ruby Debugger - Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=KoichiSasada.vscode-rdbg)) - * Chrome DevTools + * Integration with rich debugger frontends + + 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) | + ---|---|---|---| + Connection | UDS, TCP/IP | UDS, TCP/IP | TCP/IP | + Requirement | No | [vscode-rdbg](https://marketplace.visualstudio.com/items?itemName=KoichiSasada.vscode-rdbg) | No | + * Extensible: application can introduce debugging support with several ways: * By `rdbg` command * By loading libraries with `-r` command line option