1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Revert "build,tools: check freshness of doc addons"

Browse Source 
This reverts commit 2cb9e2a6f7c570fe317d560de840046595c3f2ec.

Reverted along with d9b59def7 as this introduces freshness checks that
are too stringent without the comprehensive dependency checking of
introduced in d9b59def7 so `make test` won't work with this.

Ref: https://github.com/nodejs/node/pull/17407
PR-URL: https://github.com/nodejs/node/pull/18287
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
This commit is contained in:
Rod Vagg 2018-01-23 21:48:49 +11:00
parent b886c424fb
commit d5d024d6ec
2 changed files with 10 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Makefile
View File

@ -225,7 +225,7 @@ v8:
.PHONY: test
# This does not run tests of third-party libraries inside deps.
test: all check-doc-addons build-addons ## Runs default tests, linters, and builds docs.
test: all build-addons ## Runs default tests, linters, and builds docs.
$(MAKE) -s doc-only
$(MAKE) -s lint
$(MAKE) -s cctest
@ -234,10 +234,6 @@ test: all check-doc-addons build-addons ## Runs default tests, linters, and buil
$(CI_NATIVE_SUITES) \
$(CI_DOC)
.PHONY: check-doc-addons
check-doc-addons: $(NODE)
$(NODE) tools/doc/addon-verify.js --check
.PHONY: test-only
test-only: all build-addons ## For a quick test, does not run linter or build docs.
$(MAKE) cctest

29
tools/doc/addon-verify.js
View File

@ -10,9 +10,6 @@ const rootDir = path.resolve(__dirname, '..', '..');
const doc = path.resolve(rootDir, 'doc', 'api', 'addons.md');
const verifyDir = path.resolve(rootDir, 'test', 'addons');
const changed = [];
const checkOnly = process.argv.includes('--check');
let id = 0;
let currentHeader;
@ -79,6 +76,12 @@ for (const header in addons) {
})
});
try {
fs.mkdirSync(dir);
} catch (e) {
strictEqual(e.code, 'EEXIST');
}
for (const file of files) {
let content;
try {
@ -88,27 +91,11 @@ for (const header in addons) {
}
// Only update when file content has changed to prevent unneeded rebuilds.
if (content === file.content) continue;
changed.push(file);
if (checkOnly) continue;
try {
fs.mkdirSync(dir);
} catch (e) {
strictEqual(e.code, 'EEXIST');
}
if (content !== file.content) {
fs.writeFileSync(file.path, file.content);
console.log('wrote', file.path);
}
}
if (checkOnly && changed.length > 0) {
console.error('The following files are out of date:');
for (const { path } of changed) console.error(' ', path);
console.error('Run `node tools/doc/addon-verify.js` to update.');
process.exit(1);
}
}
function boilerplate(name, content) {