This checks if all command line args are documented in the help message.
Example output:
$ qa/pull-tester/check-doc.py
Args used : 144
Args documented : 133
Args undocumented: 15
set(['-uacomment', '-nodebug', '-rpcssl', '-rpccookiefile', '-checkblockindex', '-benchmark', '-help', '-version', '-h', '-checkmempool', '-mocktime', '-maptxfee', '-tor', '-socks', '-debugnet'])
Args unknown : 4
set(['-zmqpubrawblock', '-zmqpubhashtx', '-zmqpubrawtx', '-zmqpubhashblock'])
$ echo $?
15
concept ACK
Nice! We just need to be clear: this would mean, we extend the CI/pull-tester from functional code testing to style/documentation quality assurance.
IMO, this is something we should do.
utACK fa0f5100493572ea7abd2b0a9d98c697adc31014.
0 | @@ -0,0 +1,39 @@ 1 | +#!/usr/bin/env python 2 | +'''
nit: add copyright header (https://github.com/MarcoFalke/bitcoin/blob/MarcoFalke-2015-travisDoc/qa/pull-tester/rpc-tests.py#L2)
Concept ACK
On Monday, 4 January 2016, Jonas Schnelli notifications@github.com wrote:
In qa/pull-tester/check-doc.py #7280 (review):
@@ -0,0 +1,39 @@ +#!/usr/bin/env python +'''
nit: add copyright header ( https://github.com/MarcoFalke/bitcoin/blob/MarcoFalke-2015-travisDoc/qa/pull-tester/rpc-tests.py#L2 )
— Reply to this email directly or view it on GitHub https://github.com/bitcoin/bitcoin/pull/7280/files#r48710140.
15 | +CMD_GREP_DOCS = r"egrep -r -I 'HelpMessageOpt\(\"\-[^\"=]+?(=|\")' %s" % (CMD_ROOT_DIR) 16 | +REGEX_ARG = re.compile(r'(?:map(?:Multi)?Args(?:\.count\(|\[)|Get(?:Bool)?Arg\()\"(\-[^\"]+?)\"') 17 | +REGEX_DOC = re.compile(r'HelpMessageOpt\(\"(\-[^\"=]+?)(?:=|\")') 18 | + 19 | +def main(): 20 | + used = check_output(CMD_GREP_ARGS, shell=True)
I'd prefer to never use any of the subprocess commands with shell=True, using a shell can easily lead to security issues.
I agree that shell=True should never be used. But I am just too lazy to translate the pipe into python. The CMD_s are hardcoded, so shell injection is rather unlikely to happen.
Concept ACK It's quite ugly to do this as long as there is no organization to the argument parsing, but as long as the risk of false positives is low it's good to add the check.
Moved check-doc.py to devtools and addressed nit by @jonasschnelli
Travis:
/home/travis/build.sh: line 45: contrib/devtools/check-doc.py: No such file or directory
Documentation was added in master, so travis should pass now.