Skip to content

Commit 0d128e3

Browse files
authored
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 e3e739d commit 0d128e3

File tree

2 files changed

+33
-11
lines changed

2 files changed

+33
-11
lines changed

doc/node.1

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -696,12 +696,22 @@ disabled.
696696
.It Ev NO_COLOR
697697
Alias for NODE_DISABLE_COLORS
698698
.
699+
.It Ev NODE_COMPILE_CACHE Ar dir
700+
Enable the
701+
.Sy module compile cache
702+
for the Node.js instance.
703+
.
699704
.It Ev NODE_DEBUG Ar modules...
700705
Comma-separated list of core modules that should print debug information.
701706
.
702707
.It Ev NODE_DEBUG_NATIVE Ar modules...
703708
Comma-separated list of C++ core modules that should print debug information.
704709
.
710+
.It Ev NODE_DISABLE_COMPILE_CACHE
711+
Disable the
712+
.Sy module compile cache
713+
for the Node.js instance.
714+
.
705715
.It Ev NODE_DISABLE_COLORS
706716
When set to
707717
.Ar 1 ,
@@ -757,6 +767,9 @@ When set to
757767
.Ar 1 ,
758768
emit pending deprecation warnings.
759769
.
770+
.It Ev NODE_PENDING_PIPE_INSTANCES
771+
Set the number of pending pipe instance handles when the pipe server is waiting for connections. This setting applies to Windows only.
772+
.
760773
.It Ev NODE_PRESERVE_SYMLINKS
761774
When set to
762775
.Ar 1 ,
@@ -790,11 +803,30 @@ the check for a supported platform is skipped during Node.js startup.
790803
Node.js might not execute correctly.
791804
Any issues encountered on unsupported platforms will not be fixed.
792805
.
806+
.It Ev NODE_TEST_CONTEXT
807+
When set to
808+
.Ar 'child'
809+
, test reporter options will be overridden and test output will be sent to stdout in the TAP format.
810+
If any other value is provided, Node.js makes no guarantees about the reporter format used or its stability.
811+
.
793812
.It Ev NODE_TLS_REJECT_UNAUTHORIZED
794813
When set to
795814
.Ar 0 ,
796815
TLS certificate validation is disabled.
797816
.
817+
.It Ev NODE_USE_ENV_PROXY
818+
When enabled, Node.js parses the
819+
.Ar HTTP_PROXY
820+
,
821+
.Ar HTTPS_PROXY
822+
and
823+
.Ar NO_PROXY
824+
environment variables during startup, and tunnels requests over the specified proxy.
825+
.Pp
826+
This currently only affects requests sent over
827+
.Ar fetch() .
828+
Support for other built-in http and https methods is under way.
829+
.
798830
.It Ev NODE_V8_COVERAGE Ar dir
799831
When set, Node.js writes JavaScript code coverage information to
800832
.Ar dir .

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)