Update man page
This commit is contained in:
Reijo Tomperi
parent
45327e46cd
commit
c078d804b9
|
|
@ -106,21 +106,24 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
|
|||
<arg choice="opt"><option>-D[id]</option></arg>
|
||||
<arg choice="opt"><option>--enable=[id]</option></arg>
|
||||
<arg choice="opt"><option>--error-exitcode=[n]</option></arg>
|
||||
<arg choice="opt"><option>--exitcode-suppressions [file]</option></arg>
|
||||
<arg choice="opt"><option>--errorlist</option></arg>
|
||||
<arg choice="opt"><option>--exitcode-suppressions=[file]</option></arg>
|
||||
<arg choice="opt"><option>--file-list=file</option></arg>
|
||||
<arg choice="opt"><option>--force</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>
|
||||
<arg choice="opt"><option>--inline-suppr</option></arg>
|
||||
<arg choice="opt"><option>-j[jobs]</option></arg>
|
||||
<arg choice="opt"><option>--quiet</option></arg>
|
||||
<arg choice="opt"><option>--report-progress</option></arg>
|
||||
<arg choice="opt"><option>--style</option></arg>
|
||||
<arg choice="opt"><option>--suppressions [file]</option></arg>
|
||||
<arg choice="opt"><option>--suppressions-list=[file]</option></arg>
|
||||
<arg choice="opt"><option>--template '[text]'</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=[version]</option></arg>
|
||||
<arg choice="opt"><option>file or path</option></arg>
|
||||
<arg choice="plain"><option>...</option></arg>
|
||||
</cmdsynopsis>
|
||||
|
|
@ -158,34 +161,40 @@ Example: -DDEBUG=1 -D__cplusplus</para>
|
|||
<varlistentry>
|
||||
<term><option>--enable=[id]</option></term>
|
||||
<listitem>
|
||||
<para>Enable specific checks. The available ids are:
|
||||
<para>Enable additional checks. The available ids are:
|
||||
<glosslist>
|
||||
<glossentry>
|
||||
<glossterm>all</glossterm>
|
||||
<glossdef>
|
||||
<para>Enable all checks.</para>
|
||||
<para>Enable all checks</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
<glossentry>
|
||||
<glossterm>style</glossterm>
|
||||
<glossdef>
|
||||
<para>Check coding style.</para>
|
||||
<para>Check coding style</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.</para>
|
||||
<para>Check for unused functions</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
<glossentry>
|
||||
<glossterm>missingInclude</glossterm>
|
||||
<glossdef>
|
||||
<para>check for missing includes</para>
|
||||
<para>Check for missing includes</para>
|
||||
</glossdef>
|
||||
</glossentry>
|
||||
</glosslist>
|
||||
Several ids can be given if you separate them with commas, e.g. --enable=style,unusedFunction.
|
||||
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.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
|
@ -199,7 +208,13 @@ Example: -DDEBUG=1 -D__cplusplus</para>
|
|||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>--exitcode-suppressions [file]</option></term>
|
||||
<term><option>--errorlist</option></term>
|
||||
<listitem>
|
||||
<para>Print a list of all possible error messages in XML format.</para>
|
||||
</listitem>
|
||||
</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>
|
||||
|
|
@ -232,6 +247,15 @@ default.</para>
|
|||
files, this is not needed.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><option>-i [dir]</option></term>
|
||||
<listitem>
|
||||
<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>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><option>--inline-suppr</option></term>
|
||||
<listitem>
|
||||
|
|
@ -266,7 +290,7 @@ files, this is not needed.</para>
|
|||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>--suppressions [file]</option></term>
|
||||
<term><option>--suppressions-list=[file]</option></term>
|
||||
<listitem>
|
||||
<para>Suppress warnings listed in the file. Filename and line are optional. The format of the single line in file is: [error id]:[filename]:[line].
|
||||
You can use --template or --xml to see the error id.</para>
|
||||
|
|
@ -297,11 +321,17 @@ files, this is not needed.</para>
|
|||
<para>Write results in XML to error stream</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term><option>--xml-version=[version]</option></term>
|
||||
<listitem>
|
||||
<para>Select the XML file version. Currently versions 1 and 2 are available. The default version is 1.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</refsect1>
|
||||
<refsect1 id="author">
|
||||
<title>AUTHOR</title>
|
||||
<para>The program was written by Bill Egert, Daniel Marjamäki, Gianluca Scacco, Hoang Tuan Su, Kimmo Varis, Leandro Penz, Martin Ettl, Nguyen Duong Tuan, Nicolas Le Cam, Reijo Tomperi, Robert Reif, Slava Semushin, Vesa Pikki and Zachary Blair</para>
|
||||
<para>The program was written by Daniel Marjamäki and Cppcheck team. See AUTHORS file for list of team members.</para>
|
||||
</refsect1>
|
||||
<refsect1 id="see_also">
|
||||
<title>SEE ALSO</title>
|
||||
|
|
|
|||
Loading…
Reference in New Issue