Running arc lint or arc diff will run the script.
An error will be returned for each undocumented or unknown argument.
Depends on D2306
Details
Details
- Reviewers
deadalnix - Group Reviewers
Restricted Project - Commits
- rSTAGING04141e011b17: Integrates the check-doc.py script to arcanist
rABC04141e011b17: Integrates the check-doc.py script to arcanist
arc lint
Check there is no error
Add this line to src/init.cpp (don't forget to save):
// GetArg("-dummy", "default");
arc lintCheck it outputs an undocumented argument error for -dummy
Remove the line from src/init.cpp
Add this line to src/init.cpp (don't forget to save):
// HelpMessageOpt("-dummy", "Dummy documentation");
arc lintCheck it outputs an unknown argument error for -dummy
Remove the line from src/init.cpp
Diff Detail
Diff Detail
- Repository
- rABC Bitcoin ABC
- Branch
- check_doc_arcanist
- Lint
Lint Passed - Unit
No Test Coverage - Build Status
Buildable 4529 Build 7121: Bitcoin ABC Buildbot (legacy) Build 7120: arc lint + arc unit
Event Timeline
| test/lint/check-doc.py | ||
|---|---|---|
| 79 ↗ | (On Diff #6641) | Yes, but this is the same problem encountered with the previous linter. If the script returns non zero, arcanist interprets as "the script did not run correctly" instead of "some linter errors were found". |
Comment Actions
Remove the check in the release process document, no longer necessary
Avoid some local variables
| arcanist/linter/CheckDocLinter.php | ||
|---|---|---|
| 64 ↗ | (On Diff #6663) | Unfortunately not, this is the default behavior of arcanist (I should remove these lines, they are redondant). if($err != 0) {
$err = 0;
}, arcanist will throw an exception anyway. |
Comment Actions
Add an instruction to run arc lint --everything in the release process document
Remove the check against error in the PHP parsing function, as it is redundant with arcanist default behavior
| arcanist/linter/CheckDocLinter.php | ||
|---|---|---|
| 63 | It's probably better to keep the check then, to make sure you don't try to parse garbage. | |