Tweked --help output

This commit is contained in:
Daniel Marjamäki 2020-06-14 17:23:08 +02:00
parent f44192e94b
commit fac8e52379
1 changed files with 19 additions and 15 deletions

View File

@ -952,23 +952,31 @@ void CmdLineParser::printHelp()
"Options:\n" "Options:\n"
" --addon=<addon>\n" " --addon=<addon>\n"
" Execute addon. i.e. --addon=cert. If options must be\n" " Execute addon. i.e. --addon=cert. If options must be\n"
" provided a json configuration is needed, see the manual\n" " provided a json configuration is needed.\n"
" for additional information about that.\n"
" --addon-python=<python interpreter>\n" " --addon-python=<python interpreter>\n"
" Use this python interpreter to run addons.\n" " You can specify the python interpreter either in the\n"
" addon json files or through this command line option.\n"
" If not present, Cppcheck will try \"python3\" first and\n" " If not present, Cppcheck will try \"python3\" first and\n"
" then \"python\".\n" " then \"python\".\n"
" --bug-hunting\n" " --bug-hunting\n"
" Noisy and soundy analysis.\n" " Enable noisy and soundy analysis. The normal Cppcheck\n"
" analysis is turned off.\n"
" --cppcheck-build-dir=<dir>\n" " --cppcheck-build-dir=<dir>\n"
" Analysis output directory. Useful for various data.\n" " Cppcheck work folder. Advantages:\n"
" Some possible usages are; whole program analysis,\n" " * whole program analysis\n"
" incremental analysis, distributed analysis.\n" " * faster analysis; Cppcheck will reuse the results if\n"
" the hash for a file is unchanged.\n"
" * some useful debug information, i.e. commands used to\n"
" execute clang/clang-tidy/addons.\n"
" --check-config Check cppcheck configuration. The normal code\n" " --check-config Check cppcheck configuration. The normal code\n"
" analysis is disabled by this flag.\n" " analysis is disabled by this flag.\n"
" --check-library Show information messages when library files have\n" " --check-library Show information messages when library files have\n"
" incomplete info.\n" " incomplete info.\n"
" --clang Import Clang AST\n" " --clang Use Clang parser instead of the builtin Cppcheck\n"
" parser. Cppcheck executes `clang`. The Clang AST is\n"
" imported and converted into Cppcheck data. After that\n"
" the normal Cppcheck analysis is used. You must have\n"
" `clang` in PATH.\n"
" --config-exclude=<dir>\n" " --config-exclude=<dir>\n"
" Path (prefix) to be excluded from configuration\n" " Path (prefix) to be excluded from configuration\n"
" checking. Preprocessor configurations defined in\n" " checking. Preprocessor configurations defined in\n"
@ -976,7 +984,6 @@ void CmdLineParser::printHelp()
" be considered for evaluation.\n" " be considered for evaluation.\n"
" --config-excludes-file=<file>\n" " --config-excludes-file=<file>\n"
" A file that contains a list of config-excludes\n" " A file that contains a list of config-excludes\n"
" --doc Print a list of all available checks.\n"
" --dump Dump xml data for each translation unit. The dump\n" " --dump Dump xml data for each translation unit. The dump\n"
" files have the extension .dump and contain ast,\n" " files have the extension .dump and contain ast,\n"
" tokenlist, symboldatabase, valueflow.\n" " tokenlist, symboldatabase, valueflow.\n"
@ -984,9 +991,6 @@ void CmdLineParser::printHelp()
" --force is used, Cppcheck will only check the given\n" " --force is used, Cppcheck will only check the given\n"
" configuration when -D is used.\n" " configuration when -D is used.\n"
" Example: '-DDEBUG=1 -D__cplusplus'.\n" " Example: '-DDEBUG=1 -D__cplusplus'.\n"
" -U<ID> Undefine preprocessor symbol. Use -U to explicitly\n"
" hide certain #ifdef <ID> code paths from checking.\n"
" Example: '-UDEBUG'\n"
" -E Print preprocessor output on stdout and don't do any\n" " -E Print preprocessor output on stdout and don't do any\n"
" further processing.\n" " further processing.\n"
" --enable=<id> Enable additional checks. The available ids are:\n" " --enable=<id> Enable additional checks. The available ids are:\n"
@ -1117,7 +1121,6 @@ void CmdLineParser::printHelp()
" --plist-output=<path>\n" " --plist-output=<path>\n"
" Generate Clang-plist output files in folder.\n" " Generate Clang-plist output files in folder.\n"
" -q, --quiet Do not show progress reports.\n" " -q, --quiet Do not show progress reports.\n"
" -rp, --relative-paths\n"
" -rp=<paths>, --relative-paths=<paths>\n" " -rp=<paths>, --relative-paths=<paths>\n"
" Use relative paths in output. When given, <paths> are\n" " Use relative paths in output. When given, <paths> are\n"
" used as base. You can separate multiple paths by ';'.\n" " used as base. You can separate multiple paths by ';'.\n"
@ -1198,11 +1201,12 @@ void CmdLineParser::printHelp()
" \\r insert carriage return\n" " \\r insert carriage return\n"
" Example format (gcc-like):\n" " Example format (gcc-like):\n"
" '{file}:{line}:{column}: note: {info}\\n{code}'\n" " '{file}:{line}:{column}: note: {info}\\n{code}'\n"
" -U<ID> Undefine preprocessor symbol. Use -U to explicitly\n"
" hide certain #ifdef <ID> code paths from checking.\n"
" Example: '-UDEBUG'\n"
" -v, --verbose Output more detailed error information.\n" " -v, --verbose Output more detailed error information.\n"
" --version Print out version number.\n" " --version Print out version number.\n"
" --xml Write results in xml format to error stream (stderr).\n" " --xml Write results in xml format to error stream (stderr).\n"
" --xml-version=<version>\n"
" Select the XML file version. Currently only versions 2 is available."
"\n" "\n"
"Example usage:\n" "Example usage:\n"
" # Recursively check the current folder. Print the progress on the screen and\n" " # Recursively check the current folder. Print the progress on the screen and\n"