Script to find undocumented options#4136
Closed
johndoe31415 wants to merge 1 commit intoopenssl:masterfrom
Closed
Conversation
This script browses the manpages and tries all command line options and shows where the two differ: Undocumented options (i.e., where an option the help page mentions, but that doesn't appear in the manpage) and unsupported options (i.e., where an option appears in the manpage, but not in the help page).
Contributor
Author
|
For the record, I wrote this because I believed #3043 to have the root cause in an option that's undocumented in the manpage (-ignore_errs). For reference, this is what it spits out for current master: |
Contributor
|
wow, long comment :) |
Contributor
Author
|
Hi Rich, yup I feared this -- maybe it's still useful for someone, even when it never makes it mainline :-) |
Contributor
|
Is having a Python script in the distro okay if it isn't run by the build system? |
Contributor
|
Or in the tools repo? |
Contributor
|
I'm going to translate to perl and put it in the find-doc-nits script. I think it's highly useful! |
Contributor
|
BTW, you should look at the "list --missing-help" command. |
Closed
Contributor
|
Closing in favor of #4144. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This script browses the manpages and tries all command line options and
shows where the two differ: Undocumented options (i.e., where an option
the help page mentions, but that doesn't appear in the manpage) and
unsupported options (i.e., where an option appears in the manpage, but
not in the help page).
I'm aware that most other scripts are written in Perl, but I'm unable to code any perl and wrote this script just to find discrepancies in the docs. So I thought I'd give it a shot to anyone who is interested.