Page MenuHomePhabricator

Fix check-doc.py
ClosedPublic

Authored by Fabien on Jan 9 2019, 20:39.

Details

Reviewers
deadalnix
Group Reviewers
Restricted Project
Commits
rABCf06241f87ef1: Fix check-doc.py
rSTAGINGf06241f87ef1: Fix check-doc.py
Summary

Update the script to work with our codebase, especially our clang-format
rules.

Test Plan
contrib/devtools/check-doc.py

The expected ouput should contain:

  • The number of arguments used through the code (via the getters from ArgsManager)
  • The number of arguments documented in the code (via the HelpMessageOpt calls)
  • The deduced quantity and list of:
    • Undocumented arguments (arguments used but not documented)
    • Unknown arguments (arguments documented but not used)

The script exit code is the number of undocumented arguments.

Diff Detail

Repository
rABC Bitcoin ABC
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

Fabien created this revision.Jan 9 2019, 20:39
Herald added a reviewer: Restricted Project. · View Herald TranscriptJan 9 2019, 20:39
Herald added a subscriber: schancel. · View Herald Transcript
deadalnix requested changes to this revision.Jan 10 2019, 17:18

The test plan is inadequate. For all I know, running that command result in the script throwing an exception and crashing. I know for a fact that we have undocumented arguments so I would expect this to give us something if it worked.

This revision now requires changes to proceed.Jan 10 2019, 17:18
Fabien requested review of this revision.Jan 10 2019, 18:05
Fabien edited the test plan for this revision. (Show Details)

Updated the test plan with expected output

deadalnix accepted this revision.Jan 11 2019, 00:43

So there are undocumented arguments. Running that should be added to the release checklist.

This revision is now accepted and ready to land.Jan 11 2019, 00:43
This revision was automatically updated to reflect the committed changes.