man: Add missing options and normalize option formats #7123
Conversation
This file contains 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
- Add missing options to both synopsis and detailed descriptions: * --addon=<script/config> * --check-level=<level> * --clang * --cppcheck-build-dir=<path> * --file-filter=<str> * --performance-valueflow-max-if-count=<num> * --premium=<type> * --project=<file> * --project-configuration=<config> * --template-location=<format> - Standardize option formatting: * Fix inconsistent spacing in relative paths options * Add missing short options (-f, -h, -q, -v) alongside long forms * Remove trailing bracket from --xml-version * Correct --config-exclude-file to --config-excludes-file - Improve option descriptions with detailed explanations and examples
danmar
reviewed
Jan 1, 2025
| <listitem> | ||
| <para>Set checking level. Available options are:</para> | ||
| <variablelist> | ||
| <varlistentry> |
There was a problem hiding this comment.
latest git head also has "reduced" check level.
| </listitem> | ||
| </varlistentry> | ||
| <varlistentry> | ||
| <term>cert-c</term> |
| </listitem> | ||
| </varlistentry> | ||
| <varlistentry> | ||
| <term>cert-c++</term> |
| </listitem> | ||
| </varlistentry> | ||
| <varlistentry> | ||
| <term>misra-c++-2008</term> |
There was a problem hiding this comment.
lots of missing premium terms:
https://github.com/danmar/cppcheck/blob/main/cli/cmdlineparser.cpp#L1012
| <arg choice="opt"> | ||
| <option>--verbose</option> | ||
| </arg> | ||
| <arg choice="opt"> | ||
| <option>-v</option> |
There was a problem hiding this comment.
The "-v" option is misplaced, it's the same as "--verbose".
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Add missing options to both synopsis and detailed descriptions:
Standardize option formatting:
Improve option descriptions with detailed explanations and examples