From e3e2745906ff69e9757a1d42b3518d58f73eeee3 Mon Sep 17 00:00:00 2001 From: Jeremiah Senkpiel Date: Mon, 2 May 2016 17:02:31 -0400 Subject: [PATCH] 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: https://github.com/nodejs/node/pull/6377#issuecomment-215601789 PR-URL: https://github.com/nodejs/node/pull/6532 Reviewed-By: Benjamin Gruenbaum Reviewed-By: James M Snell --- doc/api/cli.md | 4 ++++ doc/node.1 | 6 ++++++ 2 files changed, 10 insertions(+) diff --git a/doc/api/cli.md b/doc/api/cli.md index e03773d1e7..ac0233b9d7 100644 --- 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 index de9ea17034..8b70cbbfa3 100644 --- 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.