Skip to content

Commit 585a35d

Browse files
committed
fixup! build: add skip_apidoc_files and include QUIC
1 parent 13d199d commit 585a35d

File tree

3 files changed

+15
-2
lines changed

3 files changed

+15
-2
lines changed

test/doctool/test-make-doc.mjs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,11 @@ const expectedJsons = linkedHtmls
4646
.map((name) => name.replace('.html', '.json'));
4747
const expectedDocs = linkedHtmls.concat(expectedJsons);
4848
const renamedDocs = ['policy.json', 'policy.html'];
49+
const skipedDocs = ['quic.json', 'quic.html'];
4950

5051
// Test that all the relative links in the TOC match to the actual documents.
5152
for (const expectedDoc of expectedDocs) {
53+
if (skipedDocs.includes(expectedDoc)) continue;
5254
assert.ok(actualDocs.includes(expectedDoc), `${expectedDoc} does not exist`);
5355
}
5456

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

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ 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+
2830
// Documented in /doc/api/deprecations.md
2931
const deprecated = [
3032
'--debug',
@@ -80,7 +82,7 @@ for (const [, envVar, config] of nodeOptionsCC.matchAll(addOptionRE)) {
8082
}
8183

8284
// CLI options
83-
if (!isV8Option && !hasTrueAsDefaultValue) {
85+
if (!isV8Option && !hasTrueAsDefaultValue && !ignoredDocs.includes(envVar)) {
8486
if (new RegExp(`###.*\`${envVar}[[=\\s\\b\`]`).test(cliText) === false) {
8587
assert(false, `Should have option ${envVar} documented`);
8688
} else {
@@ -101,7 +103,10 @@ for (const [, envVar, config] of nodeOptionsCC.matchAll(addOptionRE)) {
101103
}
102104

103105
// NODE_OPTIONS
104-
if (isInNodeOption && !hasTrueAsDefaultValue && new RegExp(`\`${envVar}\``).test(nodeOptionsText) === false) {
106+
if (isInNodeOption && !hasTrueAsDefaultValue &&
107+
new RegExp(`\`${envVar}\``).test(nodeOptionsText) === false &&
108+
!ignoredDocs.includes(envVar)
109+
) {
105110
assert(false, `Should have option ${envVar} in NODE_OPTIONS documented`);
106111
}
107112

@@ -121,6 +126,10 @@ for (const [, envVar, config] of nodeOptionsCC.matchAll(addOptionRE)) {
121126
manPagesOptions.delete(envVar.slice(1));
122127
}
123128
}
129+
130+
if (ignoredDocs.includes(envVar)) {
131+
manPagesOptions.delete(envVar.slice(1));
132+
}
124133
}
125134

126135
{

test/parallel/test-process-env-allowed-flags-are-documented.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,8 @@ assert(undocumented.delete('--verify-base-objects'));
125125
assert(undocumented.delete('--no-verify-base-objects'));
126126
assert(undocumented.delete('--trace-promises'));
127127
assert(undocumented.delete('--no-trace-promises'));
128+
assert(undocumented.delete('--experimental-quic'));
129+
assert(undocumented.delete('--no-experimental-quic'));
128130

129131
// Remove negated versions of the flags.
130132
for (const flag of undocumented) {

0 commit comments

Comments
 (0)