Version
24
Platform
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-snapshotbuild-snapshot-configdisable-sigusr1disable-warningdns-result-orderenable-network-family-autoselectionenv-file-if-existsenv-fileexperimental-network-inspectionexperimental-print-required-tlaexperimental-require-moduleexperimental-sea-configexperimental-worker-inspectionexpose-gcforce-node-api-uncaught-exceptions-policyimportnetwork-family-autoselection-attempt-timeoutno-async-context-frameno-experimental-detect-moduleno-experimental-global-navigatorno-experimental-require-moduleno-network-family-autoselectionopenssl-legacy-provideropenssl-shared-configreport-dirreport-directoryreport-exclude-envreport-exclude-networkrunsnapshot-blobtrace-envtrace-env-js-stacktrace-env-native-stacktrace-require-moduleuse-system-cawatch-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:
|
// 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', |
|
]); |
Version
24
Platform
Subsystem
doc
What steps will reproduce the bug?
Run
man nodeand view theOPTIONSsectionCompare 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-snapshotbuild-snapshot-configdisable-sigusr1disable-warningdns-result-orderenable-network-family-autoselectionenv-file-if-existsenv-fileexperimental-network-inspectionexperimental-print-required-tlaexperimental-require-moduleexperimental-sea-configexperimental-worker-inspectionexpose-gcforce-node-api-uncaught-exceptions-policyimportnetwork-family-autoselection-attempt-timeoutno-async-context-frameno-experimental-detect-moduleno-experimental-global-navigatorno-experimental-require-moduleno-network-family-autoselectionopenssl-legacy-provideropenssl-shared-configreport-dirreport-directoryreport-exclude-envreport-exclude-networkrunsnapshot-blobtrace-envtrace-env-js-stacktrace-env-native-stacktrace-require-moduleuse-system-cawatch-preserve-outputAdditional 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