diff --git a/man/cppcheck.1.xml b/man/cppcheck.1.xml index fca2c0653..4672f7773 100644 --- a/man/cppcheck.1.xml +++ b/man/cppcheck.1.xml @@ -88,7 +88,7 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/ the Free Software Foundation. On Debian systems, the complete text of the GNU General Public License can be found in - /usr/share/common-licenses/GPL-3. + /usr/share/common-licenses/GPL-3. @@ -122,10 +122,10 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/ - + - + @@ -141,11 +141,11 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/ DESCRIPTION - Cppcheck is a command-line tool that tries to detect bugs that your C/C++ - compiler doesn't see. It is versatile, and can check non-standard code - including various compiler extensions, inline assembly code, etc. - Its internal preprocessor can handle includes, macros, and several - preprocessor commands. While Cppcheck is highly configurable, + Cppcheck is a command-line tool that tries to detect bugs that your C/C++ + compiler doesn't see. It is versatile, and can check non-standard code + including various compiler extensions, inline assembly code, etc. + Its internal preprocessor can handle includes, macros, and several + preprocessor commands. While Cppcheck is highly configurable, you can start using it just by giving it a path to the source code. @@ -161,24 +161,24 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/ This allows you to provide information about functions by providing an implementation for these. - + Check Cppcheck configuration. The normal code analysis is disabled by this flag. - + - By default Cppcheck checks all configurations. Use -D to limit the checking. When -D is used the checking is limited to the given configuration. + By default Cppcheck checks all configurations. Use -D to limit the checking. When -D is used the checking is limited to the given configuration. Example: -DDEBUG=1 -D__cplusplus - By default Cppcheck checks all configurations. Use '-U' to explicitly hide certain #ifdef <id> code paths from checking. + By default Cppcheck checks all configurations. Use '-U' to explicitly hide certain #ifdef <id> code paths from checking. Example: '-UDEBUG' @@ -210,7 +210,7 @@ Example: '-UDEBUG' Enable portability messages - + information @@ -228,8 +228,8 @@ Example: '-UDEBUG' Warn if there are missing includes. For detailed information use --check-config - - + + By default none of the additional checks are enabled. Several ids can be given if you separate them with commas, e.g. --enable=style,unusedFunction. See also --std @@ -248,7 +248,7 @@ Example: '-UDEBUG' Print a list of all possible error messages in XML format. - + @@ -293,17 +293,17 @@ First given path is searched for contained header files first. If paths are rela - Give path to ignore. Give several -i parameters to ignore several paths. Give directory name or filename with path as parameter. + Give path to ignore. Give several -i parameters to ignore several paths. Give directory name or filename with path as parameter. Directory name is matched to all parts of the path. - Allow that Cppcheck reports even though the analysis is inconclusive. + Allow that Cppcheck reports even though the analysis is inconclusive. There are false positives with this option. Each result must be carefully investigated before you know if it is good or bad. - + @@ -352,18 +352,18 @@ There are false positives with this option. Each result must be carefully invest 32 bit Windows UNICODE character encoding - + win64 64 bit Windows - + By default the platform which was used to compile Cppcheck is used. - + @@ -391,13 +391,13 @@ There are false positives with this option. Each result must be carefully invest Match regular expression to create your own checks. E.g. rule "/ 0" can be used to check division by zero. - + Use given rule XML file. See https://sourceforge.net/projects/cppcheck/files/Articles/ for more info about the syntax. - + @@ -446,11 +446,11 @@ There are false positives with this option. Each result must be carefully invest C++ code is C++11 compatible (default) - + Example to set more than one standards: 'cppcheck --std=c99 --std=posix file.cpp' - + diff --git a/man/manual.docbook b/man/manual.docbook index ae2c774da..1797d9588 100644 --- a/man/manual.docbook +++ b/man/manual.docbook @@ -663,10 +663,10 @@ int a(int sz) Usage: cppcheck-htmlreport [options] Options: - -h, --help show this help message and exit - --file=FILE The cppcheck xml output file to read defects from. - Default is reading from stdin. - --report-dir=REPORT_DIR + -h, --help show this help message and exit + --file=FILE The cppcheck xml output file to read defects from. + Default is reading from stdin. + --report-dir=REPORT_DIR The directory where the html report content is written. --source-dir=SOURCE_DIR Base directory where source code files can be found. @@ -746,4 +746,3 @@ htmlreport/cppcheck-htmlreport --file=err.xml --report-dir=test1 --source-dir=.< - diff --git a/man/writing-rules-1.docbook b/man/writing-rules-1.docbook index 1dd1db043..26936d26b 100644 --- a/man/writing-rules-1.docbook +++ b/man/writing-rules-1.docbook @@ -76,7 +76,7 @@ Save that code as dealloc.cpp and then use cppcheck --rule=".+" dealloc.cpp: - $ ./cppcheck --rule=".+" dealloc.cpp + $ ./cppcheck --rule=".+" dealloc.cpp Checking dealloc.cpp... [dealloc.cpp:1]: (style) found ' void f ( ) { if ( p ) { free ( p ) ; } }'