tools: better error message for failed tools/doc/generate #25064
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When one creates a bogus `node` executable during development, sometimes an issue that comes up is a failing invocation of `tools/doc/generate.js --apilinks=...`, which continues to fail afterwards. Removing the target file helps, but there was no indication of that in the error message; therefore, print a better one and suggest removing the file in it.
nodejs-github-bot
added
doc
joyeecheung
reviewed
Dec 16, 2018
| fs.readFileSync(filename, 'utf8') | ||
| ); | ||
| } catch (e) { | ||
| console.log(`Failure reading ${filename}, maybe remove it?`); |
There was a problem hiding this comment.
I don't think removing it always solve the issue, depending on how the file is generated the next time (which in turn depends on Makefile deps handling). Usually when I run into this it's because the file is empty (JSON.parse('') errors) because the content is piped from stdout instead of being written by the bogus binary (in which case it would fail properly instead of piping out an empty file silently).
Alternative solution: #25019
|
@joyeecheung Sorry, missed your PR – thanks for pointing this out! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When one creates a bogus
nodeexecutable during development,sometimes an issue that comes up is a failing invocation
of
tools/doc/generate.js --apilinks=..., which continuesto fail afterwards. Removing the target file helps, but
there was no indication of that in the error message;
therefore, print a better one and suggest removing the file in it.
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passes