-
Notifications
You must be signed in to change notification settings - Fork 35.7k
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
Conversation
concept ACK |
Nice! IMO, this is something we should do. utACK fa0f5100493572ea7abd2b0a9d98c697adc31014. |
@@ -0,0 +1,39 @@ | |||
#!/usr/bin/env python | |||
''' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: add copyright header (https://github.com/MarcoFalke/bitcoin/blob/MarcoFalke-2015-travisDoc/qa/pull-tester/rpc-tests.py#L2)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Concept ACK
On Monday, 4 January 2016, Jonas Schnelli notifications@github.com wrote:
In qa/pull-tester/check-doc.py
#7280 (comment):@@ -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.
REGEX_DOC = re.compile(r'HelpMessageOpt\(\"(\-[^\"=]+?)(?:=|\")') | ||
|
||
def main(): | ||
used = check_output(CMD_GREP_ARGS, shell=True) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd prefer to never use any of the subprocess commands with shell=True, using a shell can easily lead to security issues.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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 |
fa0f510
to
7497b86
Compare
7497b86
to
fada0c9
Compare
Moved |
Travis:
|
128e7f0
to
a1c905c
Compare
a1c905c
to
faeda0e
Compare
Documentation was added in |
This checks if all command line args are documented in the help message.
Example output: