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

Update man page and readme to reflect the new syntax

This commit is contained in:
Reijo Tomperi 2008-12-19 19:19:26 +00:00
parent cd405f4089
commit 347068b672
2 changed files with 42 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
man/cppcheck.1.xml
View File

@ -102,12 +102,23 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
<refsynopsisdiv>
<cmdsynopsis>
<command>&dhpackage;</command>
<arg choice="opt"><option>--all</option></arg>
<arg choice="opt"><option>--style</option></arg>
<arg choice="opt"><option>--recursive</option></arg>
<arg choice="opt"><option>--errorsonly</option></arg>
<arg choice="opt"><option>--verbose</option></arg>
<arg choice="opt"><option>filename</option></arg>
<group choise="opt">
<arg choice="opt"><option>-a</option></arg>
<arg choice="opt"><option>--all</option></arg>
</group>
<group choise="opt">
<arg choice="opt"><option>-q</option></arg>
<arg choice="opt"><option>--quiet</option></arg>
</group>
<group choise="opt">
<arg choice="opt"><option>-s</option></arg>
<arg choice="opt"><option>--style</option></arg>
</group>
<group choise="opt">
<arg choice="opt"><option>-v</option></arg>
<arg choice="opt"><option>--verbose</option></arg>
</group>
<arg choice="opt"><option>file or path</option></arg>
<arg choice="plain"><option>...</option></arg>
</cmdsynopsis>
</refsynopsisdiv>
@ -132,24 +143,18 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
found a bug. When this option is given, all messages are shown.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--quiet</option></term>
<listitem>
<para>Only print something when there is an error.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--style</option></term>
<listitem>
<para>Check coding style.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--recursive</option></term>
<listitem>
<para>Recursively check all *.cpp, *.cxx, *.cc and *.c files.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--errorsonly</option></term>
<listitem>
<para>Only print something when there is an error.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--verbose</option></term>
<listitem>

38
readme.txt
View File

@ -1,19 +1,19 @@
=========
C++ check
Cppcheck
=========
About
The original name of this program is "C++check".
The name was changed to "cppcheck" (a google search is more successful now).
About
The original name of this program is "C++check".
The name was changed to "cppcheck" (a google search is more successful now).
Compiling
Any C++ compiler should work.
Any C++ compiler should work.
The Makefile works under Linux.
To make it work under Windows with DJGPP, change "g++" to "gxx".
@ -22,24 +22,24 @@ Compiling
Usage
The syntax is:
cppcheck [--all] [--errorsonly] [--style] [--recursive] [filename1] [filename2]
cppcheck [--all] [--quiet] [--style] [file or path] [file or path]
The error messages will be printed to stderr.
Example (Check all files. Use all checks):
cppcheck --style --all --recursive
To output error messages to a file use this syntax (works both on Windows and Linux):
cppcheck file.cpp 2> err.txt
cppcheck --style --all ./
To output error messages to a file use this syntax (works both on Windows and Linux):
cppcheck file.cpp 2> err.txt
Recommendations
When the "--all" flag is given you may get a lot of error messages.
Webpage
http://www.sf.net/projects/cppcheck
Webpage
http://www.sf.net/projects/cppcheck