Skip to content

Commit 4e739b2

Browse files
Improve documentation of --enable
1 parent 257b24a commit 4e739b2

1 file changed

Lines changed: 13 additions & 19 deletions

File tree

cli/cmdlineparser.cpp

Lines changed: 13 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1727,9 +1727,9 @@ void CmdLineParser::printHelp() const
17271727
" be considered for evaluation.\n"
17281728
" --config-excludes-file=<file>\n"
17291729
" A file that contains a list of config-excludes\n"
1730-
" --disable=<id> Disable individual checks.\n"
1731-
" Please refer to the documentation of --enable=<id>\n"
1732-
" for further details.\n"
1730+
" --disable=<severity> Disable checks with the given severity.\n"
1731+
" Please refer to the documentation of --enable for\n"
1732+
" further details.\n"
17331733
" --dump Dump xml data for each translation unit. The dump\n"
17341734
" files have the extension .dump and contain ast,\n"
17351735
" tokenlist, symboldatabase, valueflow.\n"
@@ -1739,31 +1739,25 @@ void CmdLineParser::printHelp() const
17391739
" Example: '-DDEBUG=1 -D__cplusplus'.\n"
17401740
" -E Print preprocessor output on stdout and don't do any\n"
17411741
" further processing.\n"
1742-
" --enable=<id> Enable additional checks. The available ids are:\n"
1743-
" * all\n"
1744-
" Enable all checks. It is recommended to only\n"
1745-
" use --enable=all when the whole program is\n"
1746-
" scanned, because this enables unusedFunction.\n"
1742+
" --enable=<severity> Enable additional checks grouped by severity. The available\n"
1743+
" severities are:\n"
17471744
" * warning\n"
1748-
" Enable warning messages\n"
1749-
" * style\n"
1750-
" Enable all coding style checks. All messages\n"
1751-
" with the severities 'style', 'warning',\n"
1752-
" 'performance' and 'portability' are enabled.\n"
17531745
" * performance\n"
1754-
" Enable performance messages\n"
17551746
" * portability\n"
1756-
" Enable portability messages\n"
17571747
" * information\n"
1758-
" Enable information messages\n"
1748+
" * style\n"
1749+
" Enable checks with severities 'style', 'warning',\n"
1750+
" 'performance' and 'portability'.\n"
17591751
" * unusedFunction\n"
17601752
" Check for unused functions. It is recommended\n"
17611753
" to only enable this when the whole program is\n"
17621754
" scanned.\n"
17631755
" * missingInclude\n"
1764-
" Warn if there are missing includes.\n"
1765-
" Several ids can be given if you separate them with\n"
1766-
" commas. See also --std\n"
1756+
" Check for missing include files.\n"
1757+
" * all\n"
1758+
" Enable all checks.\n"
1759+
" Several severities/ids can be given if you separate them with\n"
1760+
" commas.\n"
17671761
" --error-exitcode=<n> If errors are found, integer [n] is returned instead of\n"
17681762
" the default '0'. '" << EXIT_FAILURE << "' is returned\n"
17691763
" if arguments are not valid or if no input files are\n"

0 commit comments

Comments
 (0)