Commit 60ad7af
doc: deprecate debug protocol
Due to changes in V8, the debug protocol will no longer work in Node.js
8.0.0. Note this in the documentation.
PR-URL: #10320
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>1 parent f48763c commit 60ad7af
1 file changed
Lines changed: 9 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -167,6 +167,10 @@ breakpoint) | |||
| 167 | 167 | ||
| 168 | 168 | ## Advanced Usage | |
| 169 | 169 | ||
| 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 | + | ||
| 170 | 174 | An alternative way of enabling and accessing the debugger is to start | |
| 171 | 175 | Node.js with the `--debug` command-line flag or by signaling an existing | |
| 172 | 176 | Node.js process with `SIGUSR1`. | |
@@ -179,12 +183,13 @@ process or via URI reference to the listening debugger: | |||
| 179 | 183 | * `node debug <URI>` - Connects to the process via the URI such as | |
| 180 | 184 | localhost:5858 | |
| 181 | 185 | ||
| 182 | - ## V8 Inspector Integration for Node.js | ||
| 186 | + ### V8 Inspector Integration for Node.js | ||
| 183 | 187 | ||
| 184 | 188 | **NOTE: This is an experimental feature.** | |
| 185 | 189 | ||
| 186 | 190 | V8 Inspector integration allows attaching Chrome DevTools to Node.js | |
| 187 | 191 | instances for debugging and profiling. | |
| 192 | + It uses the [Chrome Debugging Protocol][]. | ||
| 188 | 193 | ||
| 189 | 194 | V8 Inspector can be enabled by passing the `--inspect` flag when starting a | |
| 190 | 195 | 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: | |||
| 201 | 206 | chrome-devtools://devtools/remote/serve_file/@60cd6e859b9f557d2312f5bf532f6aec5f284980/inspector.html?experiments=true&v8only=true&ws=localhost:9229/node | |
| 202 | 207 | ``` | |
| 203 | 208 | ||
| 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