astyle formatting

[ci skip]
This commit is contained in:
Daniel Marjamäki 2018-10-13 18:42:09 +02:00
parent 5328caa6fa
commit 140b0b5ae9
2 changed files with 304 additions and 256 deletions

View File

@ -1,7 +1,5 @@
<?xml version='1.0' encoding='UTF-8'?> <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!-- <!--
`xsltproc -''-nonet \ `xsltproc -''-nonet \
@ -42,25 +40,18 @@ Validation can be done using: `xmllint -''-noout -''-valid manpage.xml`
General documentation about man-pages and man-page-formatting: General documentation about man-pages and man-page-formatting:
man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
--> --><!-- Fill in your name for FIRSTNAME and SURNAME. --><!ENTITY dhfirstname "Reijo">
<!ENTITY dhsurname "Tomperi">
<!-- Fill in your name for FIRSTNAME and SURNAME. --> <!-- dhusername could also be set to "&firstname; &surname;". --><!ENTITY dhusername "&dhfirstname; &dhsurname;">
<!ENTITY dhfirstname "Reijo"> <!ENTITY dhemail "aggro80@users.sourceforge.net">
<!ENTITY dhsurname "Tomperi"> <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
<!-- dhusername could also be set to "&firstname; &surname;". -->
<!ENTITY dhusername "&dhfirstname; &dhsurname;">
<!ENTITY dhemail "aggro80@users.sourceforge.net">
<!-- SECTION should be 1-8, maybe w/ subsection other parameters are
allowed: see man(7), man(1) and allowed: see man(7), man(1) and
http://www.tldp.org/HOWTO/Man-Page/q2.html. --> http://www.tldp.org/HOWTO/Man-Page/q2.html. --><!ENTITY dhsection "1">
<!ENTITY dhsection "1"> <!-- TITLE should be something like "User commands" or similar (see
<!-- TITLE should be something like "User commands" or similar (see http://www.tldp.org/HOWTO/Man-Page/q2.html). --><!ENTITY dhtitle "cppcheck User Manual">
http://www.tldp.org/HOWTO/Man-Page/q2.html). --> <!ENTITY dhucpackage "CPPCHECK">
<!ENTITY dhtitle "cppcheck User Manual"> <!ENTITY dhpackage "cppcheck">
<!ENTITY dhucpackage "CPPCHECK">
<!ENTITY dhpackage "cppcheck">
]> ]>
<refentry> <refentry>
<refentryinfo> <refentryinfo>
<title>&dhtitle;</title> <title>&dhtitle;</title>
@ -102,47 +93,129 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
<refsynopsisdiv> <refsynopsisdiv>
<cmdsynopsis> <cmdsynopsis>
<command>&dhpackage;</command> <command>&dhpackage;</command>
<arg choice="opt"><option>--check-config</option></arg> <arg choice="opt">
<arg choice="opt"><option>--check-library</option></arg> <option>--check-config</option>
<arg choice="opt"><option>-D&lt;id&gt;</option></arg> </arg>
<arg choice="opt"><option>-U&lt;id&gt;</option></arg> <arg choice="opt">
<arg choice="opt"><option>--enable=&lt;id&gt;</option></arg> <option>--check-library</option>
<arg choice="opt"><option>--error-exitcode=&lt;n&gt;</option></arg> </arg>
<arg choice="opt"><option>--errorlist</option></arg> <arg choice="opt">
<arg choice="opt"><option>--exitcode-suppressions=&lt;file&gt;</option></arg> <option>-D&lt;id&gt;</option>
<arg choice="opt"><option>--file-list=&lt;file&gt;</option></arg> </arg>
<arg choice="opt"><option>--force</option></arg> <arg choice="opt">
<arg choice="opt"><option>--help</option></arg> <option>-U&lt;id&gt;</option>
<arg choice="opt"><option>-I&lt;dir&gt;</option></arg> </arg>
<arg choice="opt"><option>--includes-file=&lt;file&gt;</option></arg> <arg choice="opt">
<arg choice="opt"><option>--config-exclude=&lt;dir&gt;</option></arg> <option>--enable=&lt;id&gt;</option>
<arg choice="opt"><option>--config-excludes-file=&lt;file&gt;</option></arg> </arg>
<arg choice="opt"><option>--include=&lt;file&gt;</option></arg> <arg choice="opt">
<arg choice="opt"><option>-i&lt;dir&gt;</option></arg> <option>--error-exitcode=&lt;n&gt;</option>
<arg choice="opt"><option>--inconclusive</option></arg> </arg>
<arg choice="opt"><option>--inline-suppr</option></arg> <arg choice="opt">
<arg choice="opt"><option>-j&lt;jobs&gt;</option></arg> <option>--errorlist</option>
<arg choice="opt"><option>-l&lt;load&gt;</option></arg> </arg>
<arg choice="opt"><option>--language=&lt;language&gt;</option></arg> <arg choice="opt">
<arg choice="opt"><option>--library=&lt;cfg&gt;</option></arg> <option>--exitcode-suppressions=&lt;file&gt;</option>
<arg choice="opt"><option>--max-configs=&lt;limit&gt;</option></arg> </arg>
<arg choice="opt"><option>--platform=&lt;type&gt;</option></arg> <arg choice="opt">
<arg choice="opt"><option>--quiet</option></arg> <option>--file-list=&lt;file&gt;</option>
<arg choice="opt"><option>--relative-paths=&lt;paths&gt;</option></arg> </arg>
<arg choice="opt"><option>--report-progress</option></arg> <arg choice="opt">
<arg choice="opt"><option>--rule=&lt;rule&gt;</option></arg> <option>--force</option>
<arg choice="opt"><option>--rule-file=&lt;file&gt;</option></arg> </arg>
<arg choice="opt"><option>--std=&lt;id&gt;</option></arg> <arg choice="opt">
<arg choice="opt"><option>--suppress=&lt;spec&gt;</option></arg> <option>--help</option>
<arg choice="opt"><option>--suppressions-list=&lt;file&gt;</option></arg> </arg>
<arg choice="opt"><option>--suppress-xml=&lt;.xml file&gt;</option></arg> <arg choice="opt">
<arg choice="opt"><option>--template='&lt;text&gt;'</option></arg> <option>-I&lt;dir&gt;</option>
<arg choice="opt"><option>--verbose</option></arg> </arg>
<arg choice="opt"><option>--version</option></arg> <arg choice="opt">
<arg choice="opt"><option>--xml</option></arg> <option>--includes-file=&lt;file&gt;</option>
<arg choice="opt"><option>--xml-version=&lt;version&gt;]</option></arg> </arg>
<arg choice="opt"><option>file or path</option></arg> <arg choice="opt">
<arg choice="plain"><option>...</option></arg> <option>--config-exclude=&lt;dir&gt;</option>
</arg>
<arg choice="opt">
<option>--config-excludes-file=&lt;file&gt;</option>
</arg>
<arg choice="opt">
<option>--include=&lt;file&gt;</option>
</arg>
<arg choice="opt">
<option>-i&lt;dir&gt;</option>
</arg>
<arg choice="opt">
<option>--inconclusive</option>
</arg>
<arg choice="opt">
<option>--inline-suppr</option>
</arg>
<arg choice="opt">
<option>-j&lt;jobs&gt;</option>
</arg>
<arg choice="opt">
<option>-l&lt;load&gt;</option>
</arg>
<arg choice="opt">
<option>--language=&lt;language&gt;</option>
</arg>
<arg choice="opt">
<option>--library=&lt;cfg&gt;</option>
</arg>
<arg choice="opt">
<option>--max-configs=&lt;limit&gt;</option>
</arg>
<arg choice="opt">
<option>--platform=&lt;type&gt;</option>
</arg>
<arg choice="opt">
<option>--quiet</option>
</arg>
<arg choice="opt">
<option>--relative-paths=&lt;paths&gt;</option>
</arg>
<arg choice="opt">
<option>--report-progress</option>
</arg>
<arg choice="opt">
<option>--rule=&lt;rule&gt;</option>
</arg>
<arg choice="opt">
<option>--rule-file=&lt;file&gt;</option>
</arg>
<arg choice="opt">
<option>--std=&lt;id&gt;</option>
</arg>
<arg choice="opt">
<option>--suppress=&lt;spec&gt;</option>
</arg>
<arg choice="opt">
<option>--suppressions-list=&lt;file&gt;</option>
</arg>
<arg choice="opt">
<option>--suppress-xml=&lt;.xml file&gt;</option>
</arg>
<arg choice="opt">
<option>--template='&lt;text&gt;'</option>
</arg>
<arg choice="opt">
<option>--verbose</option>
</arg>
<arg choice="opt">
<option>--version</option>
</arg>
<arg choice="opt">
<option>--xml</option>
</arg>
<arg choice="opt">
<option>--xml-version=&lt;version&gt;]</option>
</arg>
<arg choice="opt">
<option>file or path</option>
</arg>
<arg choice="plain">
<option>...</option>
</arg>
</cmdsynopsis> </cmdsynopsis>
</refsynopsisdiv> </refsynopsisdiv>
<refsect1 id="description"> <refsect1 id="description">
@ -163,96 +236,59 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
variablelist.term.break.after parameters to variablelist.term.break.after parameters to
control the term elements. --> control the term elements. -->
<varlistentry> <varlistentry>
<term><option>--check-config</option></term> <term>
<option>--check-config</option>
</term>
<listitem> <listitem>
<para>Check Cppcheck configuration. The normal code analysis is disabled by this flag.</para> <para>Check Cppcheck configuration. The normal code analysis is disabled by this flag.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--check-library</option></term> <term>
<option>--check-library</option>
</term>
<listitem> <listitem>
<para>Show information messages when library files have incomplete info.</para> <para>Show information messages when library files have incomplete info.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-D&lt;id&gt;</option></term> <term>
<option>-D&lt;id&gt;</option>
</term>
<listitem> <listitem>
<para>By default Cppcheck checks all configurations. Use -D to limit the checking. When -D is used the checking is limited to the given configuration. <para>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</para> Example: -DDEBUG=1 -D__cplusplus</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-U&lt;id&gt;</option></term> <term>
<option>-U&lt;id&gt;</option>
</term>
<listitem> <listitem>
<para>By default Cppcheck checks all configurations. Use '-U' to explicitly hide certain #ifdef &lt;id&gt; code paths from checking. <para>By default Cppcheck checks all configurations. Use '-U' to explicitly hide certain #ifdef &lt;id&gt; code paths from checking.
Example: '-UDEBUG'</para> Example: '-UDEBUG'</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--enable=&lt;id&gt;</option></term> <term>
<option>--enable=&lt;id&gt;</option>
</term>
<listitem> <listitem>
<para>Enable additional checks. The available ids are: <para>Enable additional checks. The available ids are:
<glosslist> <glosslist><glossentry><glossterm>all</glossterm><glossdef><para>Enable all checks. It is recommended to only use
<glossentry>
<glossterm>all</glossterm>
<glossdef>
<para>Enable all checks. It is recommended to only use
--enable=all when the whole program is scanned, because this --enable=all when the whole program is scanned, because this
enables unusedFunction.</para> enables unusedFunction.</para></glossdef></glossentry><glossentry><glossterm>warning</glossterm><glossdef><para>Enable warning messages</para></glossdef></glossentry><glossentry><glossterm>style</glossterm><glossdef><para>Enable all coding style checks. All messages with the
</glossdef>
</glossentry>
<glossentry>
<glossterm>warning</glossterm>
<glossdef>
<para>Enable warning messages</para>
</glossdef>
</glossentry>
<glossentry>
<glossterm>style</glossterm>
<glossdef>
<para>Enable all coding style checks. All messages with the
severities 'style', 'performance' and 'portability' are severities 'style', 'performance' and 'portability' are
enabled.</para> enabled.</para></glossdef></glossentry><glossentry><glossterm>performance</glossterm><glossdef><para>Enable performance messages</para></glossdef></glossentry><glossentry><glossterm>portability</glossterm><glossdef><para>Enable portability messages</para></glossdef></glossentry><glossentry><glossterm>information</glossterm><glossdef><para>Enable information messages</para></glossdef></glossentry><glossentry><glossterm>unusedFunction</glossterm><glossdef><para>Check for unused functions. It is recommend to only
</glossdef> enable this when the whole program is scanned</para></glossdef></glossentry><glossentry><glossterm>missingInclude</glossterm><glossdef><para>Warn if there are missing includes. For detailed information use --check-config</para></glossdef></glossentry></glosslist>
</glossentry>
<glossentry>
<glossterm>performance</glossterm>
<glossdef>
<para>Enable performance messages</para>
</glossdef>
</glossentry>
<glossentry>
<glossterm>portability</glossterm>
<glossdef>
<para>Enable portability messages</para>
</glossdef>
</glossentry>
<glossentry>
<glossterm>information</glossterm>
<glossdef>
<para>Enable information messages</para>
</glossdef>
</glossentry>
<glossentry>
<glossterm>unusedFunction</glossterm>
<glossdef>
<para>Check for unused functions. It is recommend to only
enable this when the whole program is scanned</para>
</glossdef>
</glossentry>
<glossentry>
<glossterm>missingInclude</glossterm>
<glossdef>
<para>Warn if there are missing includes. For detailed information use --check-config</para>
</glossdef>
</glossentry>
</glosslist>
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 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
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--error-exitcode=&lt;n&gt;</option></term> <term>
<option>--error-exitcode=&lt;n&gt;</option>
</term>
<listitem> <listitem>
<para>If errors are found, integer &lt;n&gt; is returned instead of default 0. <para>If errors are found, integer &lt;n&gt; is returned instead of default 0.
EXIT_FAILURE is returned if arguments are not valid or if no input files are EXIT_FAILURE is returned if arguments are not valid or if no input files are
@ -261,248 +297,244 @@ Example: '-UDEBUG'</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--errorlist</option></term> <term>
<option>--errorlist</option>
</term>
<listitem> <listitem>
<para>Print a list of all possible error messages in XML format.</para> <para>Print a list of all possible error messages in XML format.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--exitcode-suppressions=&lt;file&gt;</option></term> <term>
<option>--exitcode-suppressions=&lt;file&gt;</option>
</term>
<listitem> <listitem>
<para>Used when certain messages should be displayed but should not cause a non-zero exitcode.</para> <para>Used when certain messages should be displayed but should not cause a non-zero exitcode.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--file-list=&lt;file&gt;</option></term> <term>
<option>--file-list=&lt;file&gt;</option>
</term>
<listitem> <listitem>
<para>Specify the files to check in a text file. One filename per line. When file is -, the file list will be read from standard input.</para> <para>Specify the files to check in a text file. One filename per line. When file is -, the file list will be read from standard input.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-f</option></term> <term>
<term><option>--force</option></term> <option>-f</option>
</term>
<term>
<option>--force</option>
</term>
<listitem> <listitem>
<para>Force checking of files that have a lot of configurations. Error is printed if such a file is found so there is no reason to use this by <para>Force checking of files that have a lot of configurations. Error is printed if such a file is found so there is no reason to use this by
default. If used together with --max-configs=, the last option is the one that is effective.</para> default. If used together with --max-configs=, the last option is the one that is effective.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-h</option></term> <term>
<term><option>--help</option></term> <option>-h</option>
</term>
<term>
<option>--help</option>
</term>
<listitem> <listitem>
<para>Print help text.</para> <para>Print help text.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-I &lt;dir&gt;</option></term> <term>
<option>-I &lt;dir&gt;</option>
</term>
<listitem> <listitem>
<para>Give path to search for include files. Give several -I parameters to give several paths. First given path is <para>Give path to search for include files. Give several -I parameters to give several paths. First given path is
searched for contained header files first. If paths are relative to source files, this is not needed.</para> searched for contained header files first. If paths are relative to source files, this is not needed.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--includes-file=&lt;file&gt;</option></term> <term>
<option>--includes-file=&lt;file&gt;</option>
</term>
<listitem> <listitem>
<para>Specify directory paths to search for included header files in a text file. Add one include path per line. <para>Specify directory paths to search for included header files in a text file. Add one include path per line.
First given path is searched for contained header files first. If paths are relative to source files, this is not needed.</para> First given path is searched for contained header files first. If paths are relative to source files, this is not needed.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--config-exclude=&lt;dir&gt;</option></term> <term>
<option>--config-exclude=&lt;dir&gt;</option>
</term>
<listitem> <listitem>
<para>Path (prefix) to be excluded from configuration checking. Preprocessor configurations defined in headers <para>Path (prefix) to be excluded from configuration checking. Preprocessor configurations defined in headers
(but not sources) matching the prefix will not be considered for evaluation of configuration alternatives.</para> (but not sources) matching the prefix will not be considered for evaluation of configuration alternatives.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--config-exclude-file=&lt;file&gt;</option></term> <term>
<option>--config-exclude-file=&lt;file&gt;</option>
</term>
<listitem> <listitem>
<para>A file that contains a list of config-excludes.</para> <para>A file that contains a list of config-excludes.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--include=&lt;file&gt;</option></term> <term>
<option>--include=&lt;file&gt;</option>
</term>
<listitem> <listitem>
<para>Force inclusion of a file before the checked file. Can be used for example when checking the Linux kernel, <para>Force inclusion of a file before the checked file. Can be used for example when checking the Linux kernel,
where autoconf.h needs to be included for every file compiled. Works the same way as the GCC -include option.</para> where autoconf.h needs to be included for every file compiled. Works the same way as the GCC -include option.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-i &lt;dir&gt;</option></term> <term>
<option>-i &lt;dir&gt;</option>
</term>
<listitem> <listitem>
<para>Give path to ignore. Give several -i parameters to ignore several paths. Give directory name or filename with path as parameter. <para>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.</para> Directory name is matched to all parts of the path.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--inconclusive</option></term> <term>
<option>--inconclusive</option>
</term>
<listitem> <listitem>
<para>Allow that Cppcheck reports even though the analysis is inconclusive. <para>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.</para> There are false positives with this option. Each result must be carefully investigated before you know if it is good or bad.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--inline-suppr</option></term> <term>
<option>--inline-suppr</option>
</term>
<listitem> <listitem>
<para>Enable inline suppressions. Use them by placing comments in the form: // cppcheck-suppress memleak <para>Enable inline suppressions. Use them by placing comments in the form: // cppcheck-suppress memleak
before the line to suppress.</para> before the line to suppress.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-j &lt;jobs&gt;</option></term> <term>
<option>-j &lt;jobs&gt;</option>
</term>
<listitem> <listitem>
<para>Start &lt;jobs&gt; threads to do the checking work.</para> <para>Start &lt;jobs&gt; threads to do the checking work.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-l &lt;load&gt;</option></term> <term>
<option>-l &lt;load&gt;</option>
</term>
<listitem> <listitem>
<para>Specifies that no new threads should be started if there are other threads running and the load average is at least <para>Specifies that no new threads should be started if there are other threads running and the load average is at least
&lt;load&gt; (ignored on non UNIX-like systems)</para> &lt;load&gt; (ignored on non UNIX-like systems)</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--language=&lt;language&gt;</option></term> <term>
<option>--language=&lt;language&gt;</option>
</term>
<listitem> <listitem>
<para>Forces cppcheck to check all files as the given language. Valid <para>Forces cppcheck to check all files as the given language. Valid
values are: c, c++</para> values are: c, c++</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--library=&lt;cfg&gt;</option></term> <term>
<option>--library=&lt;cfg&gt;</option>
</term>
<listitem> <listitem>
<para>Use library configuration.</para> <para>Use library configuration.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--max-configs=&lt;limit&gt;</option></term> <term>
<option>--max-configs=&lt;limit&gt;</option>
</term>
<listitem> <listitem>
<para>Maximum number of configurations to check in a file before skipping it. Default is 12. If used together with --force, the last option is <para>Maximum number of configurations to check in a file before skipping it. Default is 12. If used together with --force, the last option is
the one that is effective.</para> the one that is effective.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--platform=&lt;type&gt;</option></term> <term>
<option>--platform=&lt;type&gt;</option>
</term>
<listitem> <listitem>
<para>Specifies platform specific types and sizes.The available platforms are: <para>Specifies platform specific types and sizes.The available platforms are:
<glosslist> <glosslist><glossentry><glossterm>unix32</glossterm><glossdef><para>32 bit unix variant</para></glossdef></glossentry><glossentry><glossterm>unix64</glossterm><glossdef><para>64 bit unix variant</para></glossdef></glossentry><glossentry><glossterm>win32A</glossterm><glossdef><para>32 bit Windows ASCII character encoding</para></glossdef></glossentry><glossentry><glossterm>win32W</glossterm><glossdef><para>32 bit Windows UNICODE character encoding</para></glossdef></glossentry><glossentry><glossterm>win64</glossterm><glossdef><para>64 bit Windows</para></glossdef></glossentry></glosslist>
<glossentry>
<glossterm>unix32</glossterm>
<glossdef>
<para>32 bit unix variant</para>
</glossdef>
</glossentry>
<glossentry>
<glossterm>unix64</glossterm>
<glossdef>
<para>64 bit unix variant</para>
</glossdef>
</glossentry>
<glossentry>
<glossterm>win32A</glossterm>
<glossdef>
<para>32 bit Windows ASCII character encoding</para>
</glossdef>
</glossentry>
<glossentry>
<glossterm>win32W</glossterm>
<glossdef>
<para>32 bit Windows UNICODE character encoding</para>
</glossdef>
</glossentry>
<glossentry>
<glossterm>win64</glossterm>
<glossdef>
<para>64 bit Windows</para>
</glossdef>
</glossentry>
</glosslist>
By default the platform which was used to compile Cppcheck is used. By default the platform which was used to compile Cppcheck is used.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-q</option></term> <term>
<term><option>--quiet</option></term> <option>-q</option>
</term>
<term>
<option>--quiet</option>
</term>
<listitem> <listitem>
<para>Only print something when there is an error.</para> <para>Only print something when there is an error.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-rp</option></term> <term>
<term><option>-rp=&lt;paths&gt;</option></term> <option>-rp</option>
<term><option>--relative-paths;</option></term> </term>
<term><option>--relative-paths=&lt;paths&gt;</option></term> <term>
<option>-rp=&lt;paths&gt;</option>
</term>
<term>
<option>--relative-paths;</option>
</term>
<term>
<option>--relative-paths=&lt;paths&gt;</option>
</term>
<listitem> <listitem>
<para>Use relative paths in output. When given, &lt;paths&gt; are used as base. You can separate multiple paths by ';'. Otherwise path where source files are searched is used. E.g. if given value is test, when checking test/test.cpp, the path in output will be test.cpp instead of test/test.cpp. The feature uses string comparison to create relative paths, so using e.g. ~ for home folder does not work. It is currently only possible to apply the base paths to files that are on a lower level in the directory tree.</para> <para>Use relative paths in output. When given, &lt;paths&gt; are used as base. You can separate multiple paths by ';'. Otherwise path where source files are searched is used. E.g. if given value is test, when checking test/test.cpp, the path in output will be test.cpp instead of test/test.cpp. The feature uses string comparison to create relative paths, so using e.g. ~ for home folder does not work. It is currently only possible to apply the base paths to files that are on a lower level in the directory tree.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--report-progress</option></term> <term>
<option>--report-progress</option>
</term>
<listitem> <listitem>
<para>Report progress when checking a file.</para> <para>Report progress when checking a file.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--rule=&lt;rule&gt;</option></term> <term>
<option>--rule=&lt;rule&gt;</option>
</term>
<listitem> <listitem>
<para>Match regular expression to create your own checks. E.g. rule &quot;/ 0&quot; can be used to check division by zero. This command is only available if cppcheck was compiled with HAVE_RULES=yes.</para> <para>Match regular expression to create your own checks. E.g. rule "/ 0" can be used to check division by zero. This command is only available if cppcheck was compiled with HAVE_RULES=yes.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--rule-file=&lt;file&gt;</option></term> <term>
<option>--rule-file=&lt;file&gt;</option>
</term>
<listitem> <listitem>
<para>Use given rule XML file. See https://sourceforge.net/projects/cppcheck/files/Articles/ for more info about the syntax. This command is only available if cppcheck was compiled with HAVE_RULES=yes.</para> <para>Use given rule XML file. See https://sourceforge.net/projects/cppcheck/files/Articles/ for more info about the syntax. This command is only available if cppcheck was compiled with HAVE_RULES=yes.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--std=&lt;id&gt;</option></term> <term>
<option>--std=&lt;id&gt;</option>
</term>
<listitem> <listitem>
<para>Set standard. The available options are: <para>Set standard. The available options are:
<glosslist> <glosslist><glossentry><glossterm>posix</glossterm><glossdef><para>POSIX compatible code</para></glossdef></glossentry><glossentry><glossterm>c89</glossterm><glossdef><para>C code is C89 compatible</para></glossdef></glossentry><glossentry><glossterm>c99</glossterm><glossdef><para>C code is C99 compatible</para></glossdef></glossentry><glossentry><glossterm>c11</glossterm><glossdef><para>C code is C11 compatible (default)</para></glossdef></glossentry><glossentry><glossterm>c++03</glossterm><glossdef><para>C++ code is C++03 compatible</para></glossdef></glossentry><glossentry><glossterm>c++11</glossterm><glossdef><para>C++ code is C++11 compatible (default)</para></glossdef></glossentry></glosslist>
<glossentry>
<glossterm>posix</glossterm>
<glossdef>
<para>POSIX compatible code</para>
</glossdef>
</glossentry>
<glossentry>
<glossterm>c89</glossterm>
<glossdef>
<para>C code is C89 compatible</para>
</glossdef>
</glossentry>
<glossentry>
<glossterm>c99</glossterm>
<glossdef>
<para>C code is C99 compatible</para>
</glossdef>
</glossentry>
<glossentry>
<glossterm>c11</glossterm>
<glossdef>
<para>C code is C11 compatible (default)</para>
</glossdef>
</glossentry>
<glossentry>
<glossterm>c++03</glossterm>
<glossdef>
<para>C++ code is C++03 compatible</para>
</glossdef>
</glossentry>
<glossentry>
<glossterm>c++11</glossterm>
<glossdef>
<para>C++ code is C++11 compatible (default)</para>
</glossdef>
</glossentry>
</glosslist>
Example to set more than one standards: 'cppcheck --std=c99 --std=posix file.cpp' Example to set more than one standards: 'cppcheck --std=c99 --std=posix file.cpp'
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--suppress=&lt;spec&gt;</option></term> <term>
<option>--suppress=&lt;spec&gt;</option>
</term>
<listitem> <listitem>
<para>Suppress a specific warning. The format of &lt;spec&gt; is: [error id]:[filename]:[line]. <para>Suppress a specific warning. The format of &lt;spec&gt; is: [error id]:[filename]:[line].
The [filename] and [line] are optional. The [filename] and [line] are optional.
@ -511,45 +543,61 @@ There are false positives with this option. Each result must be carefully invest
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--suppressions-list=&lt;file&gt;</option></term> <term>
<option>--suppressions-list=&lt;file&gt;</option>
</term>
<listitem> <listitem>
<para>Suppress warnings listed in the file. <para>Suppress warnings listed in the file.
Each suppression is in the format of &lt;spec&gt; above.</para> Each suppression is in the format of &lt;spec&gt; above.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--suppress-xml=&lt;.xml file&gt;</option></term> <term>
<option>--suppress-xml=&lt;.xml file&gt;</option>
</term>
<listitem> <listitem>
<para>Use suppressions defined in xml as described in the manual</para> <para>Use suppressions defined in xml as described in the manual</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--template='&lt;text&gt;'</option></term> <term>
<option>--template='&lt;text&gt;'</option>
</term>
<listitem> <listitem>
<para>Format the error messages. E.g. '{file}:{line},{severity},{id},{message}' or '{file}({line}):({severity}) {message}'. Pre-defined templates: gcc, vs</para> <para>Format the error messages. E.g. '{file}:{line},{severity},{id},{message}' or '{file}({line}):({severity}) {message}'. Pre-defined templates: gcc, vs</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-v</option></term> <term>
<term><option>--verbose</option></term> <option>-v</option>
</term>
<term>
<option>--verbose</option>
</term>
<listitem> <listitem>
<para>More detailed error reports</para> <para>More detailed error reports</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--version</option></term> <term>
<option>--version</option>
</term>
<listitem> <listitem>
<para>Print out version information</para> <para>Print out version information</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--xml</option></term> <term>
<option>--xml</option>
</term>
<listitem> <listitem>
<para>Write results in XML to error stream</para> <para>Write results in XML to error stream</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--xml-version=&lt;version&gt;</option></term> <term>
<option>--xml-version=&lt;version&gt;</option>
</term>
<listitem> <listitem>
<para>Select the XML file version. Currently versions 1 and 2 are available. The default version is 1.</para> <para>Select the XML file version. Currently versions 1 and 2 are available. The default version is 1.</para>
</listitem> </listitem>