OSSForks/node
1
0
Fork 0
mirror of https://github.com/zebrajr/node.git synced 2025-12-06 00:20:08 +01:00
Code Issues Actions 8 Packages Projects Releases Wiki Activity

doc: add missing environment variables to manpage

Browse Source 
PR-URL: https://github.com/nodejs/node/pull/58963
Fixes: https://github.com/nodejs/node/issues/58894
Reviewed-By: Dario Piotrowicz <dario.piotrowicz@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
This commit is contained in:
amir lavasani 2025-07-11 11:08:24 +03:30 committed by GitHub
parent e3e739de63
commit 0d128e39ef
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 33 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
doc/node.1
View File

@ -696,12 +696,22 @@ disabled.
.It Ev NO_COLOR
Alias for NODE_DISABLE_COLORS
.
.It Ev NODE_COMPILE_CACHE Ar dir
Enable the
.Sy module compile cache
for the Node.js instance.
.
.It Ev NODE_DEBUG Ar modules...
Comma-separated list of core modules that should print debug information.
.
.It Ev NODE_DEBUG_NATIVE Ar modules...
Comma-separated list of C++ core modules that should print debug information.
.
.It Ev NODE_DISABLE_COMPILE_CACHE
Disable the
.Sy module compile cache
for the Node.js instance.
.
.It Ev NODE_DISABLE_COLORS
When set to
.Ar 1 ,
@ -757,6 +767,9 @@ When set to
.Ar 1 ,
emit pending deprecation warnings.
.
.It Ev NODE_PENDING_PIPE_INSTANCES
Set the number of pending pipe instance handles when the pipe server is waiting for connections. This setting applies to Windows only.
.
.It Ev NODE_PRESERVE_SYMLINKS
When set to
.Ar 1 ,
@ -790,11 +803,30 @@ the check for a supported platform is skipped during Node.js startup.
Node.js might not execute correctly.
Any issues encountered on unsupported platforms will not be fixed.
.
.It Ev NODE_TEST_CONTEXT
When set to
.Ar 'child'
, test reporter options will be overridden and test output will be sent to stdout in the TAP format.
If any other value is provided, Node.js makes no guarantees about the reporter format used or its stability.
.
.It Ev NODE_TLS_REJECT_UNAUTHORIZED
When set to
.Ar 0 ,
TLS certificate validation is disabled.
.
.It Ev NODE_USE_ENV_PROXY
When enabled, Node.js parses the
.Ar HTTP_PROXY
,
.Ar HTTPS_PROXY
and
.Ar NO_PROXY
environment variables during startup, and tunnels requests over the specified proxy.
.Pp
This currently only affects requests sent over
.Ar fetch() .
Support for other built-in http and https methods is under way.
.
.It Ev NODE_V8_COVERAGE Ar dir
When set, Node.js writes JavaScript code coverage information to
.Ar dir .

12
test/parallel/test-cli-node-cli-manpage-env-vars.mjs
View File

@ -21,18 +21,8 @@ assert(manpageEnvVarNames.size > 0,
'Unexpectedly not even a single env variable was detected when scanning the `doc/node.1` file'
);
// TODO(dario-piotrowicz): add the missing env variables to the manpage and remove this set
// (refs: https://github.com/nodejs/node/issues/58894)
const knownEnvVariablesMissingFromManPage = new Set([
'NODE_COMPILE_CACHE',
'NODE_DISABLE_COMPILE_CACHE',
'NODE_PENDING_PIPE_INSTANCES',
'NODE_TEST_CONTEXT',
'NODE_USE_ENV_PROXY',
]);
for (const envVarName of cliMdEnvVarNames) {
if (!manpageEnvVarNames.has(envVarName) && !knownEnvVariablesMissingFromManPage.has(envVarName)) {
if (!manpageEnvVarNames.has(envVarName)) {
assert.fail(`The "${envVarName}" environment variable (present in \`doc/api/cli.md\`) is missing from the \`doc/node.1\` file`);
}
manpageEnvVarNames.delete(envVarName);