OSSForks/node
1
0
Fork 0
mirror of https://github.com/zebrajr/node.git synced 2026-01-15 12:15:26 +00:00
Code Issues Actions 8 Packages Projects Releases Wiki Activity

Fix #7065: cli help documentation for --inspect

Browse Source 
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>
This commit is contained in:
Noj Vek
2017-03-15 19:34:51 -07:00
committed by James M Snell
parent 6473737bb1
commit 38299d2456
2 changed files with 32 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
doc/api/cli.md
View File

@@ -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

11
doc/node.1
View File

@@ -92,6 +92,17 @@ Open the REPL even if stdin does not appear to be a terminal.
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.