Skip to content

Commit 12118d8

Browse files
committed
Document --check-level better
1 parent c0d9a76 commit 12118d8

2 files changed

Lines changed: 21 additions & 2 deletions

File tree

man/manual.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -957,7 +957,26 @@ Example usage:
957957
./cppcheck gui/test.cpp --xml 2> err.xml
958958
htmlreport/cppcheck-htmlreport --file=err.xml --report-dir=test1 --source-dir=.
959959

960-
# Performance - Limit analysis
960+
# Check Level
961+
962+
## Normal
963+
964+
The "normal" check level is chosen by default. Our aim is that this checking level will provide an effective checking in "reasonable" time.
965+
966+
The "normal" check level should be useful during active development:
967+
* checking files while you edit them.
968+
* block changes to the repo
969+
* etc
970+
971+
## Exhaustive
972+
973+
When you can wait longer for the results you can enable the "exhaustive" checking, by using the option `--check-level=exhaustive`.
974+
975+
Exhaustive checking level should be useful for scenarios where you can wait for results. For instance:
976+
* nightly builds
977+
* etc
978+
979+
# Speeding up analysis
961980

962981
## Limit preprocessor configurations
963982

releasenotes.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
release notes for cppcheck-2.11
22

3+
- The new option --check-level=<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.
34
- The platform type 'Unspecified' within .cppcheck projects has been deprecated and will be removed in Cppcheck 2.14. Please use 'unspecified' instead.
45
- 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.
56
- "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
1213
- `constVariable`
1314
- `constVariableReference`
1415
- `constVariablePointer`
15-
- 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
1616
- 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.

0 commit comments

Comments
 (0)