manuals: remove remaining occurrences of --append
This commit is contained in:
parent
3432257390
commit
531278e075
|
@ -706,90 +706,14 @@ CLASS="programlisting"
|
||||||
><P
|
><P
|
||||||
></P
|
></P
|
||||||
></DIV
|
></DIV
|
||||||
><DIV
|
>
|
||||||
CLASS="chapter"
|
<DIV
|
||||||
><HR><H1
|
|
||||||
><A
|
|
||||||
NAME="AEN172"
|
|
||||||
></A
|
|
||||||
>Chapter 7. Leaks</H1
|
|
||||||
><P
|
|
||||||
>Looking for memory leaks and resource leaks is a key feature of
|
|
||||||
Cppcheck. Cppcheck can detect many common mistakes by default. But through
|
|
||||||
some tweaking you can improve the checking.</P
|
|
||||||
><DIV
|
|
||||||
CLASS="section"
|
|
||||||
><HR><H2
|
|
||||||
CLASS="section"
|
|
||||||
><A
|
|
||||||
NAME="AEN175"
|
|
||||||
>7.1. Userdefined allocation/deallocation functions</A
|
|
||||||
></H2
|
|
||||||
><P
|
|
||||||
><TT
|
|
||||||
CLASS="literal"
|
|
||||||
>Cppcheck</TT
|
|
||||||
> understands many common allocation and
|
|
||||||
deallocation functions. But not all.</P
|
|
||||||
><P
|
|
||||||
>Here is example code that might leak memory or resources:</P
|
|
||||||
><P
|
|
||||||
><PRE
|
|
||||||
CLASS="programlisting"
|
|
||||||
>void foo(int x)
|
|
||||||
{
|
|
||||||
void *f = CreateFred();
|
|
||||||
if (x == 1)
|
|
||||||
return;
|
|
||||||
DestroyFred(f);
|
|
||||||
}</PRE
|
|
||||||
></P
|
|
||||||
><P
|
|
||||||
>If you analyse that with Cppcheck it won't find any leaks:</P
|
|
||||||
><PRE
|
|
||||||
CLASS="programlisting"
|
|
||||||
>cppcheck --enable=possibleError fred1.cpp</PRE
|
|
||||||
><P
|
|
||||||
>You can add some custom leaks checking by providing simple
|
|
||||||
implementations for the allocation and deallocation functions. Write
|
|
||||||
this in a separate file:</P
|
|
||||||
><PRE
|
|
||||||
CLASS="programlisting"
|
|
||||||
>void *CreateFred()
|
|
||||||
{
|
|
||||||
return malloc(100);
|
|
||||||
}
|
|
||||||
|
|
||||||
void DestroyFred(void *p)
|
|
||||||
{
|
|
||||||
free(p);
|
|
||||||
}</PRE
|
|
||||||
><P
|
|
||||||
>When Cppcheck see this it understands that CreateFred will return
|
|
||||||
allocated memory and that DestroyFred will deallocate memory.</P
|
|
||||||
><P
|
|
||||||
>Now, execute <TT
|
|
||||||
CLASS="literal"
|
|
||||||
>Cppcheck</TT
|
|
||||||
> this way:</P
|
|
||||||
><PRE
|
|
||||||
CLASS="programlisting"
|
|
||||||
>cppcheck --append=fred.cpp fred1.cpp</PRE
|
|
||||||
><P
|
|
||||||
>The output from cppcheck is:</P
|
|
||||||
><PRE
|
|
||||||
CLASS="programlisting"
|
|
||||||
>Checking fred1.cpp...
|
|
||||||
[fred1.cpp:5]: (error) Memory leak: f</PRE
|
|
||||||
></DIV
|
|
||||||
></DIV
|
|
||||||
><DIV
|
|
||||||
CLASS="chapter"
|
CLASS="chapter"
|
||||||
><HR><H1
|
><HR><H1
|
||||||
><A
|
><A
|
||||||
NAME="AEN192"
|
NAME="AEN192"
|
||||||
></A
|
></A
|
||||||
>Chapter 8. Exception safety</H1
|
>Chapter 7. Exception safety</H1
|
||||||
><P
|
><P
|
||||||
>Cppcheck has a few checks that ensure that you don't break the basic
|
>Cppcheck has a few checks that ensure that you don't break the basic
|
||||||
guarantee of exception safety. It doesn't have any checks for the strong
|
guarantee of exception safety. It doesn't have any checks for the strong
|
||||||
|
@ -857,7 +781,7 @@ CLASS="chapter"
|
||||||
><A
|
><A
|
||||||
NAME="AEN212"
|
NAME="AEN212"
|
||||||
></A
|
></A
|
||||||
>Chapter 9. Html report</H1
|
>Chapter 8. Html report</H1
|
||||||
><P
|
><P
|
||||||
>You can convert the xml output from cppcheck into a html report.
|
>You can convert the xml output from cppcheck into a html report.
|
||||||
You'll need python and the pygments module
|
You'll need python and the pygments module
|
||||||
|
@ -903,14 +827,14 @@ CLASS="chapter"
|
||||||
><A
|
><A
|
||||||
NAME="AEN224"
|
NAME="AEN224"
|
||||||
></A
|
></A
|
||||||
>Chapter 10. Graphical user interface</H1
|
>Chapter 9. Graphical user interface</H1
|
||||||
><DIV
|
><DIV
|
||||||
CLASS="section"
|
CLASS="section"
|
||||||
><H2
|
><H2
|
||||||
CLASS="section"
|
CLASS="section"
|
||||||
><A
|
><A
|
||||||
NAME="AEN226"
|
NAME="AEN226"
|
||||||
>10.1. Introduction</A
|
>9.1. Introduction</A
|
||||||
></H2
|
></H2
|
||||||
><P
|
><P
|
||||||
>A Cppcheck GUI is available.</P
|
>A Cppcheck GUI is available.</P
|
||||||
|
@ -924,7 +848,7 @@ CLASS="section"
|
||||||
CLASS="section"
|
CLASS="section"
|
||||||
><A
|
><A
|
||||||
NAME="AEN230"
|
NAME="AEN230"
|
||||||
>10.2. Check source code</A
|
>9.2. Check source code</A
|
||||||
></H2
|
></H2
|
||||||
><P
|
><P
|
||||||
>Use the <TT
|
>Use the <TT
|
||||||
|
@ -938,7 +862,7 @@ CLASS="section"
|
||||||
CLASS="section"
|
CLASS="section"
|
||||||
><A
|
><A
|
||||||
NAME="AEN234"
|
NAME="AEN234"
|
||||||
>10.3. Inspecting results</A
|
>9.3. Inspecting results</A
|
||||||
></H2
|
></H2
|
||||||
><P
|
><P
|
||||||
>The results are shown in a list.</P
|
>The results are shown in a list.</P
|
||||||
|
@ -965,7 +889,7 @@ CLASS="section"
|
||||||
CLASS="section"
|
CLASS="section"
|
||||||
><A
|
><A
|
||||||
NAME="AEN242"
|
NAME="AEN242"
|
||||||
>10.4. Settings</A
|
>9.4. Settings</A
|
||||||
></H2
|
></H2
|
||||||
><P
|
><P
|
||||||
>The language can be changed at any time by using the
|
>The language can be changed at any time by using the
|
||||||
|
@ -989,7 +913,7 @@ CLASS="section"
|
||||||
CLASS="section"
|
CLASS="section"
|
||||||
><A
|
><A
|
||||||
NAME="AEN249"
|
NAME="AEN249"
|
||||||
>10.5. Project files</A
|
>9.5. Project files</A
|
||||||
></H2
|
></H2
|
||||||
><P
|
><P
|
||||||
>The project files are used to store project specific settings.
|
>The project files are used to store project specific settings.
|
||||||
|
|
|
@ -102,7 +102,6 @@ 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>--append=<file></option></arg>
|
|
||||||
<arg choice="opt"><option>--check-config</option></arg>
|
<arg choice="opt"><option>--check-config</option></arg>
|
||||||
<arg choice="opt"><option>--check-library</option></arg>
|
<arg choice="opt"><option>--check-library</option></arg>
|
||||||
<arg choice="opt"><option>-D<id></option></arg>
|
<arg choice="opt"><option>-D<id></option></arg>
|
||||||
|
@ -162,12 +161,6 @@ man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
|
||||||
<!-- Use the variablelist.term.separator and the
|
<!-- Use the variablelist.term.separator and the
|
||||||
variablelist.term.break.after parameters to
|
variablelist.term.break.after parameters to
|
||||||
control the term elements. -->
|
control the term elements. -->
|
||||||
<varlistentry>
|
|
||||||
<term><option>--append=<file></option></term>
|
|
||||||
<listitem>
|
|
||||||
<para>This allows you to provide information about functions by providing an implementation for these.</para>
|
|
||||||
</listitem>
|
|
||||||
</varlistentry>
|
|
||||||
<varlistentry>
|
<varlistentry>
|
||||||
<term><option>--check-config</option></term>
|
<term><option>--check-config</option></term>
|
||||||
<listitem>
|
<listitem>
|
||||||
|
|
Loading…
Reference in New Issue