diff options
| author | Jan Krems <jan.krems@groupon.com> | 2016-12-17 10:51:15 -0800 |
|---|---|---|
| committer | Rich Trott <rtrott@gmail.com> | 2017-01-04 09:28:07 -0800 |
| commit | 59a61a2ba77798174ead2cf57c90c83af45a11f3 (patch) | |
| tree | 3e4f63db77eb4369996ca8d853ed10b049d89a8a /doc/api/debugger.md | |
| parent | 2826e6324c80a3d1221e0ef529be22b6709d05cb (diff) | |
| download | android-node-v8-59a61a2ba77798174ead2cf57c90c83af45a11f3.tar.gz android-node-v8-59a61a2ba77798174ead2cf57c90c83af45a11f3.tar.bz2 android-node-v8-59a61a2ba77798174ead2cf57c90c83af45a11f3.zip | |
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: https://github.com/nodejs/node/pull/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>
Diffstat (limited to 'doc/api/debugger.md')
| -rw-r--r-- | doc/api/debugger.md | 11 |
1 files changed, 9 insertions, 2 deletions
diff --git a/doc/api/debugger.md b/doc/api/debugger.md index e81a0e46ea..3baf3d13f3 100644 --- a/doc/api/debugger.md +++ b/doc/api/debugger.md @@ -167,6 +167,10 @@ breakpoint) ## Advanced Usage +### TCP-based protocol + +> Stability: 0 - Deprecated: Use [V8 Inspector Integration][] instead. The debug protocol used by the `--debug` flag was removed from V8. + An alternative way of enabling and accessing the debugger is to start Node.js with the `--debug` command-line flag or by signaling an existing Node.js process with `SIGUSR1`. @@ -179,12 +183,13 @@ process or via URI reference to the listening debugger: * `node debug <URI>` - Connects to the process via the URI such as localhost:5858 -## V8 Inspector Integration for Node.js +### V8 Inspector Integration for Node.js **NOTE: This is an experimental feature.** V8 Inspector integration allows attaching Chrome DevTools to Node.js instances for debugging and profiling. +It uses the [Chrome Debugging Protocol][]. V8 Inspector can be enabled by passing the `--inspect` flag when starting a 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: chrome-devtools://devtools/remote/serve_file/@60cd6e859b9f557d2312f5bf532f6aec5f284980/inspector.html?experiments=true&v8only=true&ws=localhost:9229/node ``` -[TCP-based protocol]: https://github.com/v8/v8/wiki/Debugging-Protocol
\ No newline at end of file +[Chrome Debugging Protocol]: https://chromedevtools.github.io/debugger-protocol-viewer/ +[TCP-based protocol]: #debugger_tcp_based_protocol +[V8 Inspector Integration]: #debugger_v8_inspector_integration_for_node_js |