Skip to content

Commit 9d02960

Browse files
HumaneLogictargos
authored andcommitted
doc: add missing environment variables to manpage
PR-URL: #58963Fixes: #58894 Reviewed-By: Dario Piotrowicz <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
1 parent 83cdf17 commit 9d02960

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
@@ -693,12 +693,22 @@ disabled.
693693
.ItEvNO_COLOR
694694
Alias for NODE_DISABLE_COLORS
695695
.
696+
.ItEvNODE_COMPILE_CACHEArdir
697+
Enable the
698+
.Symodulecompilecache
699+
for the Node.js instance.
700+
.
696701
.ItEvNODE_DEBUGArmodules...
697702
Comma-separated list of core modules that should print debug information.
698703
.
699704
.ItEvNODE_DEBUG_NATIVEArmodules...
700705
Comma-separated list of C++ core modules that should print debug information.
701706
.
707+
.ItEvNODE_DISABLE_COMPILE_CACHE
708+
Disable the
709+
.Symodulecompilecache
710+
for the Node.js instance.
711+
.
702712
.ItEvNODE_DISABLE_COLORS
703713
When set to
704714
.Ar1 ,
@@ -754,6 +764,9 @@ When set to
754764
.Ar1 ,
755765
emit pending deprecation warnings.
756766
.
767+
.ItEvNODE_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
.ItEvNODE_PRESERVE_SYMLINKS
758771
When set to
759772
.Ar1 ,
@@ -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+
.ItEvNODE_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
.ItEvNODE_TLS_REJECT_UNAUTHORIZED
791810
When set to
792811
.Ar0 ,
793812
TLS certificate validation is disabled.
794813
.
814+
.ItEvNODE_USE_ENV_PROXY
815+
When enabled, Node.js parses the
816+
.ArHTTP_PROXY
817+
,
818+
.ArHTTPS_PROXY
819+
and
820+
.ArNO_PROXY
821+
environment variables during startup, and tunnels requests over the specified proxy.
822+
.Pp
823+
This currently only affects requests sent over
824+
.Arfetch() .
825+
Support for other built-in http and https methods is under way.
826+
.
795827
.ItEvNODE_V8_COVERAGEArdir
796828
When set, Node.js writes JavaScript code coverage information to
797829
.Ardir .

‎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-
constknownEnvVariablesMissingFromManPage=newSet([
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(constenvVarNameofcliMdEnvVarNames){
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)