walkero
/
cppcheck
1
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity

updated manual and CLI --help output

This commit is contained in:
Daniel Marjamäki 2013-07-20 09:38:44 +02:00
parent 4a2c200b7a
commit a216edfd07
2 changed files with 40 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
cli/cmdlineparser.cpp
View File

@ -760,7 +760,8 @@ void CmdLineParser::PrintHelp()
" by providing an implementation for them.\n"
" --check-config Check cppcheck configuration. The normal code\n"
" analysis is disabled by this flag.\n"
" --check-library Warn when library files have incomplete info.\n"
" --check-library Show information messages when library files have\n"
" incomplete info.\n"
" -D<ID> Define preprocessor symbol. Unless --max-configs or\n"
" --force is used, Cppcheck will only check the given\n"
" configuration when -D is used.\n"
@ -842,6 +843,8 @@ void CmdLineParser::PrintHelp()
" --language=<language>, -x <language>\n"
" Forces cppcheck to check all files as the given\n"
" language. Valid values are: c, c++\n"
" --library=<cfg>\n"
" Use library configuration.\n"
" --max-configs=<limit>\n"
" Maximum number of configurations to check in a file\n"
" before skipping it. Default is '12'. If used together\n"

39
man/cppcheck.1.xml
View File

@ -104,6 +104,7 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
<command>&dhpackage;</command>
<arg choice="opt"><option>--append=&lt;file&gt;</option></arg>
<arg choice="opt"><option>--check-config</option></arg>
<arg choice="opt"><option>--check-library</option></arg>
<arg choice="opt"><option>-D&lt;id&gt;</option></arg>
<arg choice="opt"><option>-U&lt;id&gt;</option></arg>
<arg choice="opt"><option>--enable=&lt;id&gt;</option></arg>
@ -119,6 +120,8 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
<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>--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>
@ -168,6 +171,12 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
<para>Check Cppcheck configuration. The normal code analysis is disabled by this flag.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--check-library</option></term>
<listitem>
<para>Show information messages when library files have incomplete info.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-D&lt;id&gt;</option></term>
<listitem>
@ -190,13 +199,23 @@ Example: '-UDEBUG'</para>
<glossentry>
<glossterm>all</glossterm>
<glossdef>
<para>Enable all checks</para>
<para>Enable all checks. It is recommended to only use
--enable=all when the whole program is scanned, because this
enables unusedFunction.</para>
</glossdef>
</glossentry>
<glossentry>
<glossterm>warning</glossterm>
<glossdef>
<para>Enable warning messages</para>
</glossdef>
</glossentry>
<glossentry>
<glossterm>style</glossterm>
<glossdef>
<para>Check coding style</para>
<para>Enable all coding style checks. All messages with the
severities 'style', 'performance' and 'portability' are
enabled.</para>
</glossdef>
</glossentry>
<glossentry>
@ -220,7 +239,8 @@ Example: '-UDEBUG'</para>
<glossentry>
<glossterm>unusedFunction</glossterm>
<glossdef>
<para>Check for unused functions</para>
<para>Check for unused functions. It is recommend to only
enable this when the whole program is scanned</para>
</glossdef>
</glossentry>
<glossentry>
@ -317,6 +337,19 @@ There are false positives with this option. Each result must be carefully invest
<para>Start &lt;jobs&gt; threads to do the checking work.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--language=&lt;language&gt;</option></term>
<listitem>
<para>Forces cppcheck to check all files as the given language. Valid
values are: c, c++</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--library=&lt;cfg&gt;</option></term>
<listitem>
<para>Use library configuration.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--max-configs=&lt;limit&gt;</option></term>
<listitem>