From 12118d8d671e10218e3323912812178462ae4f42 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Marjam=C3=A4ki?= Date: Tue, 11 Apr 2023 15:30:07 +0200 Subject: [PATCH] Document --check-level better --- man/manual.md | 21 ++++++++++++++++++++- releasenotes.txt | 2 +- 2 files changed, 21 insertions(+), 2 deletions(-) diff --git a/man/manual.md b/man/manual.md index eb23482bf..bba4ceb39 100644 --- a/man/manual.md +++ b/man/manual.md @@ -957,7 +957,26 @@ Example usage: ./cppcheck gui/test.cpp --xml 2> err.xml htmlreport/cppcheck-htmlreport --file=err.xml --report-dir=test1 --source-dir=. -# Performance - Limit analysis +# Check Level + +## Normal + +The "normal" check level is chosen by default. Our aim is that this checking level will provide an effective checking in "reasonable" time. + +The "normal" check level should be useful during active development: + * checking files while you edit them. + * block changes to the repo + * etc + +## Exhaustive + +When you can wait longer for the results you can enable the "exhaustive" checking, by using the option `--check-level=exhaustive`. + +Exhaustive checking level should be useful for scenarios where you can wait for results. For instance: + * nightly builds + * etc + +# Speeding up analysis ## Limit preprocessor configurations diff --git a/releasenotes.txt b/releasenotes.txt index 5f98590a3..fda9b05f3 100644 --- a/releasenotes.txt +++ b/releasenotes.txt @@ -1,5 +1,6 @@ release notes for cppcheck-2.11 +- The new option --check-level= has been added that controls how much checking is made by Cppcheck. The default checking level is "normal". If you feel that you can wait longer on results you can use --check-level=exhaustive. - The platform type 'Unspecified' within .cppcheck projects has been deprecated and will be removed in Cppcheck 2.14. Please use 'unspecified' instead. - It is no longer necessary to run "--check-config" to get detailed "missingInclude" and "missingIncludeSystem" messages. They will always be issued in the regular analysis if "missingInclude" is enabled. - "missingInclude" and "missingIncludeSystem" are reported with "-j" is > 1 and processes are used in the backend (default in non-Windows binaries) @@ -12,5 +13,4 @@ release notes for cppcheck-2.11 - `constVariable` - `constVariableReference` - `constVariablePointer` -- Limit valueflow analysis in function if the "if" count is high. By default max limit is 100. Limit can be tweaked with --performance-valueflow-max-if-count - More command-line parameters will now check if the given integer argument is actually valid. Several other internal string-to-integer conversions will not be error checked.