Skip to content

Some environment variables documented in the CLI docs are missing in node manpage #58894

Open
@dario-piotrowicz

Description

@dario-piotrowicz

Version

24

Platform

All

Subsystem

doc

What steps will reproduce the bug?

Run man node and view the ENVIRONMENT section

Compare it to https://nodejs.org/api/cli.html#environment-variables_1 (permalink)

How often does it reproduce? Is there a required condition?

Always

What is the expected behavior? Why is that the expected behavior?

Whatever is documented in the CLI documentation should also be documented in the node manpage

What do you see instead?

The following environment variables are missing:

  • NODE_COMPILE_CACHE
  • NODE_DISABLE_COMPILE_CACHE
  • NODE_PENDING_PIPE_INSTANCES
  • NODE_TEST_CONTEXT
  • NODE_USE_ENV_PROXY

Additional information

They need to be added in the appropriate node.1 section.

Afterwords the following code, since no longer necessary, needs to be removed:

// 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',
]);

Metadata

Metadata

Assignees

No one assigned

    Labels

    docIssues and PRs related to the documentations.good first issueIssues that are suitable for first-time contributors.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions