Changeset View
Changeset View
Standalone View
Standalone View
contrib/devtools/check-doc.py
| Show All 11 Lines | |||||
| # FIXME: the script makes assumptions on how to find documented | # FIXME: the script makes assumptions on how to find documented | ||||
| # options - these have been broken by clang-format | # options - these have been broken by clang-format | ||||
| # reformatting of the sources. | # reformatting of the sources. | ||||
| # The script likely needs major rework. | # The script likely needs major rework. | ||||
| from subprocess import check_output | from subprocess import check_output | ||||
| import re | import re | ||||
| import sys | |||||
| FOLDER_GREP = 'src' | FOLDER_GREP = 'src' | ||||
| FOLDER_TEST = 'src/test/' | FOLDER_TEST = 'src/test/' | ||||
| CMD_ROOT_DIR = '`git rev-parse --show-toplevel`/%s' % FOLDER_GREP | CMD_ROOT_DIR = '`git rev-parse --show-toplevel`/%s' % FOLDER_GREP | ||||
| CMD_GREP_ARGS = r"egrep -r -I '(map(Multi)?Args(\.count\(|\[)|Get(Bool)?Arg\()\"\-[^\"]+?\"' %s | grep -v '%s'" % ( | CMD_GREP_ARGS = r"egrep -r -I '(map(Multi)?Args(\.count\(|\[)|Get(Bool)?Arg\()\"\-[^\"]+?\"' %s | grep -v '%s'" % ( | ||||
| CMD_ROOT_DIR, FOLDER_TEST) | CMD_ROOT_DIR, FOLDER_TEST) | ||||
| CMD_GREP_DOCS = r"egrep -r -I 'HelpMessageOpt\(\"\-[^\"=]+?(=|\")' %s" % ( | CMD_GREP_DOCS = r"egrep -r -I 'HelpMessageOpt\(\"\-[^\"=]+?(=|\")' %s" % ( | ||||
| CMD_ROOT_DIR) | CMD_ROOT_DIR) | ||||
| Show All 16 Lines | def main(): | ||||
| print "Args used : %s" % len(args_used) | print "Args used : %s" % len(args_used) | ||||
| print "Args documented : %s" % len(args_docd) | print "Args documented : %s" % len(args_docd) | ||||
| print "Args undocumented: %s" % len(args_need_doc) | print "Args undocumented: %s" % len(args_need_doc) | ||||
| print args_need_doc | print args_need_doc | ||||
| print "Args unknown : %s" % len(args_unknown) | print "Args unknown : %s" % len(args_unknown) | ||||
| print args_unknown | print args_unknown | ||||
| exit(len(args_need_doc)) | sys.exit(len(args_need_doc)) | ||||
| if __name__ == "__main__": | if __name__ == "__main__": | ||||
| main() | main() | ||||