docs: Add manpages - #346
Open
kienanstewart wants to merge 1 commit into
Open
Conversation
Signed-off-by: Kienan Stewart <kienan.stewart@burntworld.ca>
|
coverage: 99.338%. remained the same — kienanstewart:docs-man_pages into netromdk:master |
netromdk
requested changes
Aug 25, 2026
netromdk
left a comment
netromdk
left a comment
Owner
There was a problem hiding this comment.
Thank you a lot! I only found a few discrepancies to fix.
| -h, --help | ||
| Show the help information and exits. | ||
|
|
||
| -v, --version |
Owner
There was a problem hiding this comment.
Suggested change
| -v, --version | |
| -V, --version |
-v is already used for verbosity.
| --no-backport (default) | ||
| Use no backports. Clears any backports specified before this. | ||
|
|
||
| --feature==NAME |
Owner
There was a problem hiding this comment.
Suggested change
| --feature==NAME | |
| --feature=NAME |
One = only.
| verbose = ***0*** | ||
| Verbosity level 1 to 4 showing increasingly more information. Turned off at level 0. | ||
|
|
||
| print_visit = ***no*** | yes |
Owner
There was a problem hiding this comment.
Suggested change
| print_visit = ***no*** | yes | |
| print_visits = ***no*** | yes |
With an "s".
|
|
||
| .. code-block:: ini | ||
|
|
||
| exclusion-regex = |
Owner
There was a problem hiding this comment.
Suggested change
| exclusion-regex = | |
| exclusion_regex = |
With an "_".
| Exclude full names, like 'email.parser.FeedParser', from analysis. Useful to | ||
| ignore conditional logic that can trigger incompatible results. This option may | ||
| be specified multiple times. | ||
|
|
Owner
There was a problem hiding this comment.
Suggested change
| --exclude-file=FILE | |
| Exclude full names, like 'email.parser.FeedParser', from analysis but from a | |
| specified file instead. Each line constitutes an exclusion with the same | |
| format as with ``--exclude``. | |
Missing section.
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.
I based this heavily on the existing documentation. I chose to use rst2man because the README file is currently formatted with that markup already.
Fixes #345