Some CLI options 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 OPTIONS section

Compare it to https://nodejs.org/api/cli.html#options (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 options are missing:

• build-snapshot
• build-snapshot-config
• disable-sigusr1
• disable-warning
• dns-result-order
• enable-network-family-autoselection
• env-file-if-exists
• env-file
• experimental-network-inspection
• experimental-print-required-tla
• experimental-require-module
• experimental-sea-config
• experimental-worker-inspection
• expose-gc
• force-node-api-uncaught-exceptions-policy
• import
• network-family-autoselection-attempt-timeout
• no-async-context-frame
• no-experimental-detect-module
• no-experimental-global-navigator
• no-experimental-require-module
• no-network-family-autoselection
• openssl-legacy-provider
• openssl-shared-config
• report-dir
• report-directory
• report-exclude-env
• report-exclude-network
• run
• snapshot-blob
• trace-env
• trace-env-js-stack
• trace-env-native-stack
• trace-require-module
• use-system-ca
• watch-preserve-output

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-options.mjs

Lines 21 to 60 in 4b4aaf9

	// TODO(dario-piotrowicz): add the missing flags to the node.1 and remove this set
	// (refs: https://github.com/nodejs/node/issues/58895)
	const knownFlagsMissingFromManPage = new Set([
	'build-snapshot',
	'build-snapshot-config',
	'disable-sigusr1',
	'disable-warning',
	'dns-result-order',
	'enable-network-family-autoselection',
	'env-file-if-exists',
	'env-file',
	'experimental-network-inspection',
	'experimental-print-required-tla',
	'experimental-require-module',
	'experimental-sea-config',
	'experimental-worker-inspection',
	'expose-gc',
	'force-node-api-uncaught-exceptions-policy',
	'import',
	'network-family-autoselection-attempt-timeout',
	'no-async-context-frame',
	'no-experimental-detect-module',
	'no-experimental-global-navigator',
	'no-experimental-require-module',
	'no-network-family-autoselection',
	'openssl-legacy-provider',
	'openssl-shared-config',
	'report-dir',
	'report-directory',
	'report-exclude-env',
	'report-exclude-network',
	'run',
	'snapshot-blob',
	'trace-env',
	'trace-env-js-stack',
	'trace-env-native-stack',
	'trace-require-module',
	'use-system-ca',
	'watch-preserve-output',
	]);

[dario-piotrowicz]

In the above list, we might not want to actually include expose-gc (see: #58878 (comment))

[dario-piotrowicz]

In the above list, we might not want to actually include expose-gc (see: #58878 (comment))

I've opened #58909 to discuss this point

[HumaneLogic]

should i add everything to manpage except expose-gc ?

[dario-piotrowicz]

should i add everything to manpage except expose-gc ?

Yes 🙂 I would start with that and then either remove it expose-gc completely or add it to the manpage depending on the outcome of #58909

[HumaneLogic]

@dario-piotrowicz ok i start adding them then commit them then wait for #58909

[HumaneLogic]

@dario-piotrowicz i added all of them except expose-gc , in here #58969

[DhawalShankar]

Hi, I’d like to work on this issue if it’s still open. Please assign to me.

[HumaneLogic]

Hi, I’d like to work on this issue if it’s still open. Please assign to me.

i did it already #58969

[HumaneLogic]

@ dario-piotrowicz

can you review please? #58969

[Omar-Allaham25]

I would like to do it if it's still available

[HumaneLogic]

I would like to do it if it's still available

i did it already #58969