Skip to content

Commit 3ab096d

Browse files
committed
doc: add missing environment variables to manpage
1 parent 9c025a9 commit 3ab096d

File tree

5 files changed

+33
-173
lines changed

5 files changed

+33
-173
lines changed

benchmark/source_map/source-map-cache.js

Lines changed: 0 additions & 60 deletions
This file was deleted.

benchmark/source_map/source-map.js

Lines changed: 0 additions & 95 deletions
This file was deleted.

doc/node.1

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -693,12 +693,22 @@ disabled.
693693
.It Ev NO_COLOR
694694
Alias for NODE_DISABLE_COLORS
695695
.
696+
.It Ev NODE_COMPILE_CACHE Ar dir
697+
Enable the
698+
.Sy module compile cache
699+
for the Node.js instance.
700+
.
696701
.It Ev NODE_DEBUG Ar modules...
697702
Comma-separated list of core modules that should print debug information.
698703
.
699704
.It Ev NODE_DEBUG_NATIVE Ar modules...
700705
Comma-separated list of C++ core modules that should print debug information.
701706
.
707+
.It Ev NODE_DISABLE_COMPILE_CACHE
708+
Disable the
709+
.Sy module compile cache
710+
for the Node.js instance.
711+
.
702712
.It Ev NODE_DISABLE_COLORS
703713
When set to
704714
.Ar 1 ,
@@ -754,6 +764,9 @@ When set to
754764
.Ar 1 ,
755765
emit pending deprecation warnings.
756766
.
767+
.It Ev NODE_PENDING_PIPE_INSTANCES
768+
Set the number of pending pipe instance handles when the pipe server is waiting for connections. This setting applies to Windows only.
769+
.
757770
.It Ev NODE_PRESERVE_SYMLINKS
758771
When set to
759772
.Ar 1 ,
@@ -787,11 +800,30 @@ the check for a supported platform is skipped during Node.js startup.
787800
Node.js might not execute correctly.
788801
Any issues encountered on unsupported platforms will not be fixed.
789802
.
803+
.It Ev NODE_TEST_CONTEXT
804+
When set to
805+
.Ar 'child'
806+
, test reporter options will be overridden and test output will be sent to stdout in the TAP format.
807+
If any other value is provided, Node.js makes no guarantees about the reporter format used or its stability.
808+
.
790809
.It Ev NODE_TLS_REJECT_UNAUTHORIZED
791810
When set to
792811
.Ar 0 ,
793812
TLS certificate validation is disabled.
794813
.
814+
.It Ev NODE_USE_ENV_PROXY
815+
When enabled, Node.js parses the
816+
.Ar HTTP_PROXY
817+
,
818+
.Ar HTTPS_PROXY
819+
and
820+
.Ar NO_PROXY
821+
environment variables during startup, and tunnels requests over the specified proxy.
822+
.Pp
823+
This currently only affects requests sent over
824+
.Ar fetch() .
825+
Support for other built-in http and https methods is under way.
826+
.
795827
.It Ev NODE_V8_COVERAGE Ar dir
796828
When set, Node.js writes JavaScript code coverage information to
797829
.Ar dir .

test/benchmark/test-benchmark-source-map.js

Lines changed: 0 additions & 7 deletions
This file was deleted.

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)