Skip to content

Commit

Permalink
src: mention that node options are space-separated
Browse files Browse the repository at this point in the history
The documentation does not mention that the value of NODE_OPTIONS is a
space-separated list.

PR-URL: #14709
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Khaidi Chu <i@2333.moe>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
  • Loading branch information
Gabriel Schulhof committed Aug 13, 2017
1 parent 7294f57 commit 6fe72c8
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 8 deletions.
8 changes: 4 additions & 4 deletions doc/api/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -440,10 +440,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`
Expand Down
8 changes: 4 additions & 4 deletions doc/node.1
Original file line number Diff line number Diff line change
Expand Up @@ -282,10 +282,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]
Expand Down
1 change: 1 addition & 0 deletions src/node.cc
Original file line number Diff line number Diff line change
Expand Up @@ -3722,6 +3722,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"
Expand Down

0 comments on commit 6fe72c8

Please sign in to comment.