New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[travis] Fail when documentation is outdated #7280

Merged
merged 2 commits into from Jan 19, 2016

Conversation

Projects
None yet
5 participants
@MarcoFalke
Member

MarcoFalke commented Jan 4, 2016

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
@dcousens

This comment has been minimized.

Show comment
Hide comment
@dcousens

dcousens Jan 4, 2016

Contributor

concept ACK

Contributor

dcousens commented Jan 4, 2016

concept ACK

@jonasschnelli

This comment has been minimized.

Show comment
Hide comment
@jonasschnelli

jonasschnelli Jan 4, 2016

Member

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.

Member

jonasschnelli commented Jan 4, 2016

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.

@jonasschnelli

View changes

Show outdated Hide outdated qa/pull-tester/check-doc.py

@jonasschnelli jonasschnelli added the Tests label Jan 4, 2016

@laanwj

View changes

Show outdated Hide outdated qa/pull-tester/check-doc.py
@laanwj

This comment has been minimized.

Show comment
Hide comment
@laanwj

laanwj Jan 4, 2016

Member

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.

Member

laanwj commented Jan 4, 2016

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.

@MarcoFalke

This comment has been minimized.

Show comment
Hide comment
@MarcoFalke

MarcoFalke Jan 4, 2016

Member

Moved check-doc.py to devtools and addressed nit by @jonasschnelli

Member

MarcoFalke commented Jan 4, 2016

Moved check-doc.py to devtools and addressed nit by @jonasschnelli

@laanwj

This comment has been minimized.

Show comment
Hide comment
@laanwj

laanwj Jan 7, 2016

Member

Travis:

/home/travis/build.sh: line 45: contrib/devtools/check-doc.py: No such file or directory
Member

laanwj commented Jan 7, 2016

Travis:

/home/travis/build.sh: line 45: contrib/devtools/check-doc.py: No such file or directory
@MarcoFalke

This comment has been minimized.

Show comment
Hide comment
@MarcoFalke

MarcoFalke Jan 18, 2016

Member

Documentation was added in master, so travis should pass now.

Member

MarcoFalke commented Jan 18, 2016

Documentation was added in master, so travis should pass now.

@laanwj laanwj merged commit faeda0e into bitcoin:master Jan 19, 2016

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details

laanwj added a commit that referenced this pull request Jan 19, 2016

Merge pull request #7280
faeda0e [travis] Run contrib/devtools/check-doc.py early (MarcoFalke)
fada0c9 [travis] Fail when documentation is outdated (MarcoFalke)

@MarcoFalke MarcoFalke deleted the MarcoFalke:MarcoFalke-2015-travisDoc branch Jan 19, 2016

codablock added a commit to codablock/dash that referenced this pull request Sep 16, 2017

Merge pull request #7280
faeda0e [travis] Run contrib/devtools/check-doc.py early (MarcoFalke)
fada0c9 [travis] Fail when documentation is outdated (MarcoFalke)

codablock added a commit to codablock/dash that referenced this pull request Sep 19, 2017

Merge pull request #7280
faeda0e [travis] Run contrib/devtools/check-doc.py early (MarcoFalke)
fada0c9 [travis] Fail when documentation is outdated (MarcoFalke)

codablock added a commit to codablock/dash that referenced this pull request Dec 9, 2017

Merge pull request #7280
faeda0e [travis] Run contrib/devtools/check-doc.py early (MarcoFalke)
fada0c9 [travis] Fail when documentation is outdated (MarcoFalke)

codablock added a commit to codablock/dash that referenced this pull request Dec 9, 2017

Merge pull request #7280
faeda0e [travis] Run contrib/devtools/check-doc.py early (MarcoFalke)
fada0c9 [travis] Fail when documentation is outdated (MarcoFalke)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment