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

[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:

node/test/parallel/test-cli-node-cli-manpage-env-vars.mjs

Lines 24 to 32 in 4b4aaf9

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

[HumaneLogic]

hi i try to fix it, this is my first time fixing issues in open source projects

[dario-piotrowicz]

@HumaneLogic Great! It's nice to have you here, welcome to the project 😄

If you need any help just let me know 🙂

[HumaneLogic]

@dario-piotrowicz thank you very much, i'm very excited , i have some questions
i added the missing environment variables and removed lines in test-cli-node-cli-manpage-env-vars
now i should git add . and git commit -m "" (with a proper message of course)
or
git add doc\node.1 test\parallel\test-cli-node-cli-manpage-env-vars.mjs and git commit -m "" ?
then just do git push? or git push origin my-branch-name?
should i build the project?
also is there a way i can see the results in mappage locally to see if they are accurate?
is this message good "doc: add missing environment variables to manpage and remove test workaround"?
sorry for so many questions

[dario-piotrowicz]

@dario-piotrowicz thank you , i have questions

👋

i added the missing environment variables and removed lines in test-cli-node-cli-manpage-env-vars now i should git add . and git commit -m "" (with a proper message of course) or git add doc\node.1 test\parallel\test-cli-node-cli-manpage-env-vars.mjs and git commit -m "" ? then just do git push? or git push origin my-branch-name? should i build the project? also is there a way i can see the results in mappage locally to see if they are accurate? is this message good "doc: add missing environment variables to manpage and remove test workaround"? sorry for so many questions

Regarding git, yes run git add doc\node.1 test\parallel\test-cli-node-cli-manpage-env-vars.mjs (or simply git add . from the root of the repository) and then the commit, message, try to be concise since there's a character limit to it git commit -m '"doc: add missing environment variables to manpage" looks good to me 🙂

Then you can simply run git push, although it'd be more convenient to you if you used a branch different from main (before running the previously mentioned git commands)

should i build the project?

You don't necessarily need to build the project for this issue, if you want you can do that to make sure the test works as intended but if you don't the CI checks run on the PR will also validate that the test passes

How you build the project depends on your platform, you can find guidance about that and how to run tests here: https://github.com/nodejs/node/blob/main/BUILDING.md

(but again you can skip that for this issue)

sorry for so many questions

No worries 🙂

[HumaneLogic]

@dario-piotrowicz thank you, i created a PR #58924

[dario-piotrowicz]

@dario-piotrowicz thank you, i created a PR #58924

Fantastic, I'll review it tomorrow 😀

By the way I forgot to reply to your question about making sure that it works as intended...

You can run man -l doc/node.1 to view your locally updated manpage on Linux/MacOS (or under WSL in windows)

[HumaneLogic]

@dario-piotrowicz thanks