diff --git a/man/manual.docbook b/man/manual.docbook index 203ae68b8..d20d3898d 100644 --- a/man/manual.docbook +++ b/man/manual.docbook @@ -5,14 +5,14 @@ Cppcheck - 2009-11-14 + 2009-11-16 Introduction Cppcheck is an analysis tool for C/C++ code. Unlike C/C++ compilers - and many other analysis tools, we don't detect syntax errors. Cppcheck + and many other analysis tools, it doesn't detect syntax errors. Cppcheck only detects the types of bugs that the compilers normally fail to detect. The goal is no false positives. @@ -25,7 +25,7 @@ - Cppcheck is supposed to be compilable by any C++ compiler which + Cppcheck is supposed to be compilable by any C++ compiler that handles the latest C++ standard. @@ -84,12 +84,8 @@ Checking path/file2.cpp... By default, an error is only reported when Cppcheck is sure there is an - error. - - When a likely issue is discovered Cppcheck - bails out without reporting this issue - to prevent false positives. - When --all is given, these issues are - reported. + error. When --all is given issues will also be + reported when Cppcheck is unsure. The --all flag is useful but makes Cppcheck more unreliable, you will probably get false @@ -143,9 +139,8 @@ Checking path/file2.cpp...
Saving results in file - Many times you will want to save the results in a file. The - results are written to stderr and the progress messages are written to - stdout. So you can use the normal shell redirections to save to + Many times you will want to save the results in a file. You can + use the normal shell redirection for piping error output to a file. cppcheck file1.c 2> err.txt @@ -164,9 +159,7 @@ Checking path/file2.cpp...
Multithreaded checking - If you have a multicore processor, it is a good idea to use the - -j flag. To use 4 threads to check the files in a - folder: + To use 4 threads to check the files in a folder: cppcheck -j 4 path
@@ -185,7 +178,8 @@ Checking path/file2.cpp... <?xml version="1.0"?> <results> - <error file="file1.cpp" line="123" id="someError" severity="error" msg="some error text"/> + <error file="file1.cpp" line="123" id="someError" + severity="error" msg="some error text"/> </results> Attributes: @@ -278,7 +272,7 @@ gui/test.cpp,16,error,mismatchAllocDealloc,Mismatching allocation and deallocati Suppressions If you want to filter out certain errors you can suppress these. - First you need to create a suppressions file. + First you need to create a suppressions file. The format is:
[error id]:[filename] [error id]:[filename2] @@ -344,7 +338,7 @@ QPushButton Then execute cppcheck with the --auto-dealloc option: - cppcheck --auto-dealloc qt.lst file1.cpp + cppcheck --auto-dealloc qt.lst --all file1.cpp
@@ -399,7 +393,7 @@ void DestroyFred(void *p) Exception safety Cppcheck has a few checks that ensure that you don't break the basic - guarantee of exception safety. We don't have any checks for the strong + guarantee of exception safety. It doesn't have any checks for the strong guarantee yet. Example: @@ -441,6 +435,7 @@ int a(int sz) The output from Cppcheck is: - [except2.cpp:7]: (error) Throwing exception in invalid state, p points at deallocated memory + [except2.cpp:7]: (error) Throwing exception in invalid state, p points +at deallocated memory