diff options
| author | Noj Vek <noj.vek@mixpanel.com> | 2017-03-15 19:34:51 -0700 |
|---|---|---|
| committer | James M Snell <jasnell@gmail.com> | 2017-03-17 10:27:01 -0700 |
| commit | 38299d245663729982df532a91b396bedaccd399 (patch) | |
| tree | 8c233981c4b1d6df88ea4ebc05b1fe5f4520d8fb /doc | |
| parent | 6473737bb1a66930395a28095705f394196ee219 (diff) | |
| download | android-node-v8-38299d245663729982df532a91b396bedaccd399.tar.gz android-node-v8-38299d245663729982df532a91b396bedaccd399.tar.bz2 android-node-v8-38299d245663729982df532a91b396bedaccd399.zip | |
Fix #7065: cli help documentation for --inspect
Adding documentation to node.1 and cli.md
PR-URL: https://github.com/nodejs/node/pull/11660
Reviewed-By: Eugene Ostroukhov <eostroukhov@google.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/cli.md | 21 | ||||
| -rw-r--r-- | doc/node.1 | 11 |
2 files changed, 32 insertions, 0 deletions
diff --git a/doc/api/cli.md b/doc/api/cli.md index 1153d9d3a2..5e6390335b 100644 --- a/doc/api/cli.md +++ b/doc/api/cli.md @@ -94,6 +94,26 @@ Follows `require()`'s module resolution rules. `module` may be either a path to a file, or a node module name. +### `--inspect[=host:port]` +<!-- YAML +added: v6.3.0 +--> + +Activate inspector on host:port. Default is 127.0.0.1:9229. + +V8 inspector integration allows tools such as Chrome DevTools and IDEs to debug +and profile Node.js instances. The tools attach to Node.js instances via a +tcp port and communicate using the [Chrome Debugging Protocol][]. + + +### `--inspect-brk[=host:port]` +<!-- YAML +added: v7.6.0 +--> + +Activate inspector on host:port and break at start of user script. + + ### `--no-deprecation` <!-- YAML added: v0.8.0 @@ -446,6 +466,7 @@ equivalent to using the `--redirect-warnings=file` command-line flag. [emit_warning]: process.html#process_process_emitwarning_warning_name_ctor [Buffer]: buffer.html#buffer_buffer +[Chrome Debugging Protocol]: https://chromedevtools.github.io/debugger-protocol-viewer [debugger]: debugger.html [REPL]: repl.html [SlowBuffer]: buffer.html#buffer_class_slowbuffer diff --git a/doc/node.1 b/doc/node.1 index 9aa514ccf3..30087cd53e 100644 --- a/doc/node.1 +++ b/doc/node.1 @@ -93,6 +93,17 @@ Preload the specified module at startup. Follows `require()`'s module resolution rules. \fImodule\fR may be either a path to a file, or a node module name. .TP +.BR \-\-inspect \fI[=host:port]\fR +Activate inspector on host:port. Default is 127.0.0.1:9229. + +V8 Inspector integration allows attaching Chrome DevTools and IDEs to Node.js +instances for debugging and profiling. It uses the Chrome Debugging Protocol. + +.TP +.BR \-\-inspect-brk \fI[=host:port]\fR +Activate inspector on host:port and break at start of user script. + +.TP .BR \-\-no\-deprecation Silence deprecation warnings. |