Skip to content

Improve documentation of --enable #7888

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.

Sign up for GitHub

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

Merged
chrchr-github merged 2 commits into from
Oct 27, 2025
Merged

Improve documentation of --enable #7888

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4e739b2
Improve documentation of --enable
chrchr-github Oct 14, 2025
e9f681f
Update cmdlineparser.cpp [skip ci]
chrchr-github Oct 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 12 additions & 19 deletions cli/cmdlineparser.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1727,9 +1727,9 @@ void CmdLineParser::printHelp() const
" be considered for evaluation.\n"
" --config-excludes-file=<file>\n"
" A file that contains a list of config-excludes\n"
" --disable=<id> Disable individual checks.\n"
" Please refer to the documentation of --enable=<id>\n"
" for further details.\n"
" --disable=<severity> Disable checks with the given severity.\n"
" Please refer to the documentation of --enable for\n"
" further details.\n"
" --dump Dump xml data for each translation unit. The dump\n"
" files have the extension .dump and contain ast,\n"
" tokenlist, symboldatabase, valueflow.\n"
Expand All @@ -1739,31 +1739,24 @@ void CmdLineParser::printHelp() const
" Example: '-DDEBUG=1 -D__cplusplus'.\n"
" -E Print preprocessor output on stdout and don't do any\n"
" further processing.\n"
" --enable=<id> Enable additional checks. The available ids are:\n"
" * all\n"
" Enable all checks. It is recommended to only\n"
" use --enable=all when the whole program is\n"
" scanned, because this enables unusedFunction.\n"
" --enable=<severity> Enable additional checks grouped by severity. The available\n"
" severities are:\n"
" * warning\n"
" Enable warning messages\n"
" * style\n"
" Enable all coding style checks. All messages\n"
" with the severities 'style', 'warning',\n"
" 'performance' and 'portability' are enabled.\n"
" * performance\n"
" Enable performance messages\n"
" * portability\n"
" Enable portability messages\n"
" * information\n"
" Enable information messages\n"
" * style\n"
" Enable checks with severities 'style', 'warning',\n"
" 'performance' and 'portability'.\n"
" * unusedFunction\n"
" Check for unused functions. It is recommended\n"
" to only enable this when the whole program is\n"
" scanned.\n"
" * missingInclude\n"
" Warn if there are missing includes.\n"
" Several ids can be given if you separate them with\n"
" commas. See also --std\n"
" Check for missing include files.\n"
" * all\n"
" Enable all checks.\n"
" Pass multiple severities as a comma-separated list.\n"
" --error-exitcode=<n> If errors are found, integer [n] is returned instead of\n"
" the default '0'. '" << EXIT_FAILURE << "' is returned\n"
" if arguments are not valid or if no input files are\n"
Expand Down