Skip to content

Commit 65c3034

Browse files
author
Jan Krems
committed
doc: Deprecate old debug protocol
1 parent 76c7220 commit 65c3034

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

doc/api/debugger.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,10 @@ breakpoint)
167167

168168
## Advanced Usage
169169

170+
### TCP-based protocol
171+
172+
> Stability: 0 - Deprecated: Use [V8 Inspector Integration][] instead. The debug protocol used by the `--debug` flag was removed from V8.
173+
170174
An alternative way of enabling and accessing the debugger is to start
171175
Node.js with the `--debug` command-line flag or by signaling an existing
172176
Node.js process with `SIGUSR1`.
@@ -179,12 +183,13 @@ process or via URI reference to the listening debugger:
179183
* `node debug <URI>` - Connects to the process via the URI such as
180184
localhost:5858
181185

182-
## V8 Inspector Integration for Node.js
186+
### V8 Inspector Integration for Node.js
183187

184188
**NOTE: This is an experimental feature.**
185189

186190
V8 Inspector integration allows attaching Chrome DevTools to Node.js
187191
instances for debugging and profiling.
192+
It uses the [Chrome Debugging Protocol][].
188193

189194
V8 Inspector can be enabled by passing the `--inspect` flag when starting a
190195
Node.js application. It is also possible to supply a custom port with that flag,
@@ -201,4 +206,6 @@ To start debugging, open the following URL in Chrome:
201206
chrome-devtools://devtools/remote/serve_file/@60cd6e859b9f557d2312f5bf532f6aec5f284980/inspector.html?experiments=true&v8only=true&ws=localhost:9229/node
202207
```
203208

204-
[TCP-based protocol]: https://github.com/v8/v8/wiki/Debugging-Protocol
209+
[Chrome Debugging Protocol]: https://chromedevtools.github.io/debugger-protocol-viewer/
210+
[TCP-based protocol]: #debugger_tcp_based_protocol
211+
[V8 Inspector Integration]: #debugger_v8_inspector_integration_for_node_js

0 commit comments

Comments
 (0)