doc: v8 options can use either _ or -

This adds docs to the man page and online cli docs that v8 options can be used with either dashes or underscores. Refs: #6377 (comment) PR-URL: #6532 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
nodejs · May 17, 2016 · 5b47acc · 5b47acc
1 parent fa94a91
commit 5b47acc
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/doc/api/cli.md b/doc/api/cli.md
@@ -111,6 +111,10 @@ Process v8 profiler output generated using the v8 option `--prof`.
 
 Print v8 command line options.
 
+Note: v8 options allow words to be separated by both dashes (`-`) or underscores
+(`_`).
+
+For example, `--stack-trace-limit` is equivalent to `--stack_trace_limit`.
 
 ### `--tls-cipher-list=list`
 

diff --git a/doc/node.1 b/doc/node.1
@@ -107,6 +107,12 @@ Process v8 profiler output generated using the v8 option \fB\-\-prof\fR
 .BR \-\-v8\-options
 Print v8 command line options.
 
+Note: v8 options allow words to be separated by both dashes (\fB-\fR) or
+underscores (\fB_\fR).
+
+For example, \fB\-\-stack\-trace\-limit\fR is equivalent to
+\fB\-\-stack\_trace\_limit\fR
+
 .TP
 .BR \-\-v8\-pool\-size =\fInum\fR
 Set v8's thread pool size which will be used to allocate background jobs.