src: mention that node options are space-separated

The documentation does not mention that the value of NODE_OPTIONS is a space-separated list. PR-URL: #14709 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Khaidi Chu <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]>
nodejs · Aug 13, 2017 · 268a1ff · 268a1ff
1 parent 20fb690
commit 268a1ff
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 8 deletions.
diff --git a/doc/api/cli.md b/doc/api/cli.md
@@ -433,10 +433,10 @@ When set to `1`, process warnings are silenced.
 added: v8.0.0
 -->
 
-`options...` are interpreted as if they had been specified on the command line
-before the actual command line (so they can be overridden).  Node will exit with
-an error if an option that is not allowed in the environment is used, such as
-`-p` or a script file.
+A space-separated list of command line options. `options...` are interpreted as
+if they had been specified on the command line before the actual command line
+(so they can be overridden).  Node will exit with an error if an option that is
+not allowed in the environment is used, such as `-p` or a script file.
 
 Node options that are allowed are:
 - `--enable-fips`

diff --git a/doc/node.1 b/doc/node.1
@@ -278,10 +278,10 @@ When set to \fI1\fR, process warnings are silenced.
 
 .TP
 .BR NODE_OPTIONS =\fIoptions...\fR
-\fBoptions...\fR are interpreted as if they had been specified on the command
-line before the actual command line (so they can be overridden).  Node will exit
-with an error if an option that is not allowed in the environment is used, such
-as \fB-p\fR or a script file.
+A space-separated list of command line options. \fBoptions...\fR are interpreted
+as if they had been specified on the command line before the actual command line
+(so they can be overridden).  Node will exit with an error if an option that is
+not allowed in the environment is used, such as \fB-p\fR or a script file.
 
 .TP
 .BR NODE_PATH =\fIpath\fR[:\fI...\fR]

diff --git a/src/node.cc b/src/node.cc
@@ -3713,6 +3713,7 @@ static void PrintHelp() {
          "NODE_NO_WARNINGS             set to 1 to silence process warnings\n"
 #if !defined(NODE_WITHOUT_NODE_OPTIONS)
          "NODE_OPTIONS                 set CLI options in the environment\n"
+         "                             via a space-separated list\n"
 #endif
 #ifdef _WIN32
          "NODE_PATH                    ';'-separated list of directories\n"