Skip to content

Commit 40d75d0

Browse files
committed
fixup! fixup! build: add skip_apidoc_files and include QUIC
1 parent c8da4c4 commit 40d75d0

File tree

3 files changed

+7
-11
lines changed

3 files changed

+7
-11
lines changed

doc/contributing/internal-api.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,3 +39,7 @@ Enables tracing of promises for debugging and performance analysis.
3939
#### `--verify-base-objects`
4040

4141
Allows verification of base objects for debugging purposes.
42+
43+
#### `--experimental-quic`
44+
45+
Enable QUIC Protocol (under development)

src/node_options.cc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -442,7 +442,7 @@ EnvironmentOptionsParser::EnvironmentOptionsParser() {
442442
kAllowedInEnvvar,
443443
true);
444444
AddOption("--experimental-quic",
445-
"experimental QUIC API",
445+
"" /* undocumented until its development */,
446446
&EnvironmentOptions::experimental_quic,
447447
kAllowedInEnvvar);
448448
AddOption("--experimental-webstorage",

test/parallel/test-cli-node-options-docs.js

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,6 @@ const v8OptionsText = cliText.match(/<!-- v8-options start -->(.*)<!-- v8-option
2525
const manPage = path.join(rootDir, 'doc', 'node.1');
2626
const manPageText = fs.readFileSync(manPage, { encoding: 'utf8' });
2727

28-
const ignoredDocs = ['--experimental-quic'];
29-
3028
// Documented in /doc/api/deprecations.md
3129
const deprecated = [
3230
'--debug',
@@ -82,7 +80,7 @@ for (const [, envVar, config] of nodeOptionsCC.matchAll(addOptionRE)) {
8280
}
8381

8482
// CLI options
85-
if (!isV8Option && !hasTrueAsDefaultValue && !ignoredDocs.includes(envVar)) {
83+
if (!isV8Option && !hasTrueAsDefaultValue) {
8684
if (new RegExp(`###.*\`${envVar}[[=\\s\\b\`]`).test(cliText) === false) {
8785
assert(false, `Should have option ${envVar} documented`);
8886
} else {
@@ -104,9 +102,7 @@ for (const [, envVar, config] of nodeOptionsCC.matchAll(addOptionRE)) {
104102

105103
// NODE_OPTIONS
106104
if (isInNodeOption && !hasTrueAsDefaultValue &&
107-
new RegExp(`\`${envVar}\``).test(nodeOptionsText) === false &&
108-
!ignoredDocs.includes(envVar)
109-
) {
105+
new RegExp(`\`${envVar}\``).test(nodeOptionsText) === false) {
110106
assert(false, `Should have option ${envVar} in NODE_OPTIONS documented`);
111107
}
112108

@@ -126,10 +122,6 @@ for (const [, envVar, config] of nodeOptionsCC.matchAll(addOptionRE)) {
126122
manPagesOptions.delete(envVar.slice(1));
127123
}
128124
}
129-
130-
if (ignoredDocs.includes(envVar)) {
131-
manPagesOptions.delete(envVar.slice(1));
132-
}
133125
}
134126

135127
{

0 commit comments

Comments
 (0)