diff --git a/contrib/devtools/check-doc.py b/contrib/devtools/check-doc.py index ce873cb5f5..e59c02e1e6 100755 --- a/contrib/devtools/check-doc.py +++ b/contrib/devtools/check-doc.py @@ -1,74 +1,74 @@ #!/usr/bin/env python # Copyright (c) 2015-2016 The Bitcoin Core developers # Copyright (c) 2019 The Bitcoin developers # Distributed under the MIT software license, see the accompanying # file COPYING or http://www.opensource.org/licenses/mit-license.php. ''' This checks if all command line args are documented. Return value is 0 to indicate no error. Author: @MarcoFalke ''' from subprocess import check_output from pprint import PrettyPrinter import re import sys FOLDER_SRC = 'src' FOLDER_TEST = 'src/test/' PATH_SRC = '`git rev-parse --show-toplevel`/{}'.format(FOLDER_SRC) PATH_TEST = '`git rev-parse --show-toplevel`/{}'.format(FOLDER_TEST) GREP_ARGS_REGEX = r"egrep -rIzo '((Is|Get)(Bool)?Arg(s|Set)?\((\s)*)\"\-[^\"]+?\"' {}" CMD_GREP_ARGS_SRC = GREP_ARGS_REGEX.format(PATH_SRC) CMD_GREP_ARGS_TEST = GREP_ARGS_REGEX.format(PATH_TEST) CMD_GREP_DOCS = r"egrep -rIzo 'HelpMessageOpt\((\s)*\"\-[^\"=]+?(=|\")' {}".format( PATH_SRC) REGEX_ARG = re.compile( r'(?:(?:Is|Get)(?:Bool)?Arg(?:s|Set)?\((?:\s)*)\"(\-[^\"]+?)\"') REGEX_DOC = re.compile(r'HelpMessageOpt\((?:\s)*\"(\-[^\"=]+?)(?:=|\")') # list unsupported, deprecated and duplicate args as they need no documentation SET_DOC_OPTIONAL = set(['-benchmark', '-blockminsize', '-dbcrashratio', '-debugnet', '-forcecompactdb', '-help', '-parkdeepreorg', '-promiscuousmempoolflags', '-replayprotectionactivationtime', '-rpcssl', '-socks', '-tor', '-whitelistalwaysrelay']) def main(): used = check_output(CMD_GREP_ARGS_SRC, shell=True) tested = check_output(CMD_GREP_ARGS_TEST, shell=True) docd = check_output(CMD_GREP_DOCS, shell=True) args_used = set(re.findall(REGEX_ARG, used)) args_used -= set(re.findall(REGEX_ARG, tested)) - args_used -= SET_DOC_OPTIONAL args_docd = set(re.findall(REGEX_DOC, docd)) - args_need_doc = args_used - args_docd + args_need_doc = args_used - args_docd - SET_DOC_OPTIONAL args_unknown = args_docd - args_used pp = PrettyPrinter() print("Args used : {}".format(len(args_used))) print("Args documented : {}".format(len(args_docd))) - print("Args undocumented: {}".format(len(args_need_doc))) + print("Args undocumented: {} ({} don't need documentation)".format( + len(args_need_doc), len(SET_DOC_OPTIONAL))) pp.pprint(args_need_doc) print("Args unknown : {}".format(len(args_unknown))) pp.pprint(args_unknown) sys.exit(len(args_need_doc)) if __name__ == "__main__": main()