man: updated the cppcheck.1.xml file.

This commit is contained in:
Daniel Marjamäki 2010-06-05 12:13:42 +02:00
parent 1de6e94947
commit 75bac44ed8
1 changed files with 61 additions and 38 deletions

View File

@ -103,8 +103,10 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
<cmdsynopsis> <cmdsynopsis>
<command>&dhpackage;</command> <command>&dhpackage;</command>
<arg choice="opt"><option>--append [file]</option></arg> <arg choice="opt"><option>--append [file]</option></arg>
<arg choice="opt"><option>-D[id]</option></arg>
<arg choice="opt"><option>--enable=[id]</option></arg> <arg choice="opt"><option>--enable=[id]</option></arg>
<arg choice="opt"><option>--error-exitcode=[n]</option></arg> <arg choice="opt"><option>--error-exitcode=[n]</option></arg>
<arg choice="opt"><option>--exitcode-suppressions [file]</option></arg>
<arg choice="opt"><option>--force</option></arg> <arg choice="opt"><option>--force</option></arg>
<arg choice="opt"><option>--help</option></arg> <arg choice="opt"><option>--help</option></arg>
<arg choice="opt"><option>-I[dir]</option></arg> <arg choice="opt"><option>-I[dir]</option></arg>
@ -141,48 +143,50 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
<para>This allows you to provide information about functions by providing an implementation for these.</para> <para>This allows you to provide information about functions by providing an implementation for these.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><option>-D[id]</option></term>
<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>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term><option>--enable=[id]</option></term> <term><option>--enable=[id]</option></term>
<listitem> <listitem>
<para>Enable specific checks. The available ids are: <para>Enable specific checks. The available ids are:
<glosslist> <glosslist>
<glossentry><glossterm>all</glossterm> <glossentry>
<glossdef> <glossterm>all</glossterm>
<para> <glossdef>
Enable all checks. <para>Enable all checks.</para>
</para> </glossdef>
</glossdef> </glossentry>
</glossentry> <glossentry>
<glossentry><glossterm>exceptNew</glossterm> <glossterm>exceptNew</glossterm>
<glossdef> <glossdef>
<para> <para>Check exception safety when using new.</para>
Check exception safety when using new. </glossdef>
</para> </glossentry>
</glossdef> <glossentry>
</glossentry> <glossterm>exceptRealloc</glossterm>
<glossentry><glossterm>exceptRealloc</glossterm> <glossdef>
<glossdef> <para>Check exception safety when reallocating.</para>
<para> </glossdef>
Check exception safety when reallocating. </glossentry>
</para> <glossentry>
</glossdef> <glossterm>style</glossterm>
</glossentry> <glossdef>
<glossentry><glossterm>style</glossterm> <para>Check coding style.</para>
<glossdef> </glossdef>
<para> </glossentry>
Check coding style. <glossentry>
</para> <glossterm>unusedFunctions</glossterm>
</glossdef> <glossdef>
</glossentry> <para>Check for unused functions.</para>
<glossentry><glossterm>unusedFunctions</glossterm> </glossdef>
<glossdef> </glossentry>
<para> </glosslist>
Check for unused functions. Several ids can be given if you separate them with commas, e.g. --enable=style,unusedFunctions.
</para> </para>
</glossdef>
</glossentry>
</glosslist>
Several ids can be given if you separate them with commas, e.g. --enable=style,unusedFunctions.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -194,6 +198,18 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
256 can become 0.</para> 256 can become 0.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><option>--exitcode-suppressions [file]</option></term>
<listitem>
<para>Used when certain messages should be displayed but should not cause a non-zero exitcode.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--file-list=[file]</option></term>
<listitem>
<para>Specify the files to check in a text file. One filename per line.</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term><option>-f</option></term> <term><option>-f</option></term>
<term><option>--force</option></term> <term><option>--force</option></term>
@ -216,6 +232,13 @@ default.</para>
files, this is not needed.</para> files, this is not needed.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><option>--inline-suppr</option></term>
<listitem>
<para>Enable inline suppressions. Use them by placing comments in the form: // cppcheck-suppress memleak
before the line to suppress.</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term><option>-j [jobs]</option></term> <term><option>-j [jobs]</option></term>
<listitem> <listitem>