HomePhabricator

Integrates the check-doc.py script to arcanist

Description

Integrates the check-doc.py script to arcanist

Summary:
Running arc lint or arc diff will run the script.
An error will be returned for each undocumented or unknown argument.

Depends on D2306

Test Plan:

arc lint

Check there is no error

Add this line to src/init.cpp (don't forget to save):

// GetArg("-dummy", "default");
arc lint

Check 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 lint

Check it outputs an unknown argument error for -dummy
Remove the line from src/init.cpp

Reviewers: #bitcoin_abc, deadalnix

Reviewed By: #bitcoin_abc, deadalnix

Subscribers: teamcity, schancel

Differential Revision: https://reviews.bitcoinabc.org/D2307

Details

Provenance
FabienAuthored on Jan 14 2019, 09:56
FabienPushed on Jan 22 2019, 21:29
Reviewer
Restricted Project
Differential Revision
D2307: Integrates the check-doc.py script to arcanist
Parents
rSTAGING9a00f6874b71: Make check-doc.py compliant to python3
Branches
Unknown
Tags
Unknown