Skip to content

Commit

Permalink
doc, inspector: note that the host is optional
Browse files Browse the repository at this point in the history
Document that `node --inspect=${port}` is also a viable option.

PR-URL: #12149
Reviewed-By: Eugene Ostroukhov <[email protected]>
Reviewed-By: Richard Lau <[email protected]>
Reviewed-By: Michaël Zasso <[email protected]>
Reviewed-By: James M Snell <[email protected]>
  • Loading branch information
gibfahn committed Apr 4, 2017
1 parent d51f4f3 commit 2d2970e
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 6 deletions.
4 changes: 2 additions & 2 deletions doc/api/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ Follows `require()`'s module resolution
rules. `module` may be either a path to a file, or a node module name.


### `--inspect[=host:port]`
### `--inspect[=[host:]port]`
<!-- YAML
added: v6.3.0
-->
Expand All @@ -106,7 +106,7 @@ 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]`
### `--inspect-brk[=[host:]port]`
<!-- YAML
added: v7.6.0
-->
Expand Down
4 changes: 2 additions & 2 deletions doc/node.1
Original file line number Diff line number Diff line change
Expand Up @@ -93,14 +93,14 @@ 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
.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
.BR \-\-inspect-brk \fI[=[host:]port]\fR
Activate inspector on host:port and break at start of user script.

.TP
Expand Down
5 changes: 3 additions & 2 deletions src/node.cc
Original file line number Diff line number Diff line change
Expand Up @@ -3541,9 +3541,10 @@ static void PrintHelp() {
" -r, --require module to preload (option can be "
"repeated)\n"
#if HAVE_INSPECTOR
" --inspect[=host:port] activate inspector on host:port\n"
" --inspect[=[host:]port] activate inspector on host:port\n"
" (default: 127.0.0.1:9229)\n"
" --inspect-brk[=host:port] activate inspector on host:port\n"
" --inspect-brk[=[host:]port]\n"
" activate inspector on host:port\n"
" and break at start of user script\n"
#endif
" --no-deprecation silence deprecation warnings\n"
Expand Down

0 comments on commit 2d2970e

Please sign in to comment.