Skip to content

Commit b4a43ed

Browse files
HumaneLogicrichardlau
authored andcommitted
doc: add missing environment variables to manpage
PR-URL: #58963 Fixes: #58894 Reviewed-By: Dario Piotrowicz <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
1 parent 57c3009 commit b4a43ed

File tree

2 files changed

+20
-11
lines changed

2 files changed

+20
-11
lines changed

doc/node.1

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -707,12 +707,22 @@ disabled.
707707
.It Ev NO_COLOR
708708
Alias for NODE_DISABLE_COLORS
709709
.
710+
.It Ev NODE_COMPILE_CACHE Ar dir
711+
Enable the
712+
.Sy module compile cache
713+
for the Node.js instance.
714+
.
710715
.It Ev NODE_DEBUG Ar modules...
711716
Comma-separated list of core modules that should print debug information.
712717
.
713718
.It Ev NODE_DEBUG_NATIVE Ar modules...
714719
Comma-separated list of C++ core modules that should print debug information.
715720
.
721+
.It Ev NODE_DISABLE_COMPILE_CACHE
722+
Disable the
723+
.Sy module compile cache
724+
for the Node.js instance.
725+
.
716726
.It Ev NODE_DISABLE_COLORS
717727
When set to
718728
.Ar 1 ,
@@ -768,6 +778,9 @@ When set to
768778
.Ar 1 ,
769779
emit pending deprecation warnings.
770780
.
781+
.It Ev NODE_PENDING_PIPE_INSTANCES
782+
Set the number of pending pipe instance handles when the pipe server is waiting for connections. This setting applies to Windows only.
783+
.
771784
.It Ev NODE_PRESERVE_SYMLINKS
772785
When set to
773786
.Ar 1 ,
@@ -801,6 +814,12 @@ the check for a supported platform is skipped during Node.js startup.
801814
Node.js might not execute correctly.
802815
Any issues encountered on unsupported platforms will not be fixed.
803816
.
817+
.It Ev NODE_TEST_CONTEXT
818+
When set to
819+
.Ar 'child'
820+
, test reporter options will be overridden and test output will be sent to stdout in the TAP format.
821+
If any other value is provided, Node.js makes no guarantees about the reporter format used or its stability.
822+
.
804823
.It Ev NODE_TLS_REJECT_UNAUTHORIZED
805824
When set to
806825
.Ar 0 ,

test/parallel/test-cli-node-cli-manpage-env-vars.mjs

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -21,18 +21,8 @@ assert(manpageEnvVarNames.size > 0,
2121
'Unexpectedly not even a single env variable was detected when scanning the `doc/node.1` file'
2222
);
2323

24-
// TODO(dario-piotrowicz): add the missing env variables to the manpage and remove this set
25-
// (refs: https://github.com/nodejs/node/issues/58894)
26-
const knownEnvVariablesMissingFromManPage = new Set([
27-
'NODE_COMPILE_CACHE',
28-
'NODE_DISABLE_COMPILE_CACHE',
29-
'NODE_PENDING_PIPE_INSTANCES',
30-
'NODE_TEST_CONTEXT',
31-
'NODE_USE_ENV_PROXY',
32-
]);
33-
3424
for (const envVarName of cliMdEnvVarNames) {
35-
if (!manpageEnvVarNames.has(envVarName) && !knownEnvVariablesMissingFromManPage.has(envVarName)) {
25+
if (!manpageEnvVarNames.has(envVarName)) {
3626
assert.fail(`The "${envVarName}" environment variable (present in \`doc/api/cli.md\`) is missing from the \`doc/node.1\` file`);
3727
}
3828
manpageEnvVarNames.delete(envVarName);

0 commit comments

Comments
 (0)