|
From: <sv...@va...> - 2013-12-12 23:19:26
|
Author: philippe
Date: Thu Dec 12 23:19:13 2013
New Revision: 13759
Log:
Following svn r13758 (bug 328711), some further similar fixes,
Modified:
trunk/docs/xml/manual-core.xml
trunk/drd/docs/drd-manual.xml
trunk/memcheck/docs/mc-manual.xml
Modified: trunk/docs/xml/manual-core.xml
==============================================================================
--- trunk/docs/xml/manual-core.xml (original)
+++ trunk/docs/xml/manual-core.xml Thu Dec 12 23:19:13 2013
@@ -1907,7 +1907,7 @@
between fairness and performance. For more details about the
Valgrind thread serialisation scheme and its impact on
performance and thread scheduling, see
- <xref linkend="&vg-pthreads-perf-sched-id;"/>.
+ <xref linkend="&vg-pthreads-perf-sched-id;"/>.</para>
<itemizedlist>
<listitem> <para>The value <option>--fair-sched=yes</option>
@@ -1935,7 +1935,7 @@
highest performance.</para>
</listitem>
</itemizedlist>
- </para></listitem>
+ </listitem>
</varlistentry>
Modified: trunk/drd/docs/drd-manual.xml
==============================================================================
--- trunk/drd/docs/drd-manual.xml (original)
+++ trunk/drd/docs/drd-manual.xml Thu Dec 12 23:19:13 2013
@@ -385,30 +385,29 @@
<para>
Whether to report races between accessing memory and freeing
memory. Enabling this option may cause DRD to run slightly
- slower. Notes:
- <itemizedlist>
- <listitem>
- <para>
- Don't enable this option when using custom memory allocators
- that use
- the <computeroutput>VG_USERREQ__MALLOCLIKE_BLOCK</computeroutput>
- and <computeroutput>VG_USERREQ__FREELIKE_BLOCK</computeroutput>
- because that would result in false positives.
- </para>
- </listitem>
- <listitem>
- <para>Don't enable this option when using reference-counted
- objects because that will result in false positives, even when
- that code has been annotated properly with
- <computeroutput>ANNOTATE_HAPPENS_BEFORE</computeroutput>
- and <computeroutput>ANNOTATE_HAPPENS_AFTER</computeroutput>. See
- e.g. the output of the following command for an example:
- <computeroutput>valgrind --tool=drd --free-is-write=yes
- drd/tests/annotate_smart_pointer</computeroutput>.
- </para>
- </listitem>
- </itemizedlist>
- </para>
+ slower. Notes:</para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Don't enable this option when using custom memory allocators
+ that use
+ the <computeroutput>VG_USERREQ__MALLOCLIKE_BLOCK</computeroutput>
+ and <computeroutput>VG_USERREQ__FREELIKE_BLOCK</computeroutput>
+ because that would result in false positives.
+ </para>
+ </listitem>
+ <listitem>
+ <para>Don't enable this option when using reference-counted
+ objects because that will result in false positives, even when
+ that code has been annotated properly with
+ <computeroutput>ANNOTATE_HAPPENS_BEFORE</computeroutput>
+ and <computeroutput>ANNOTATE_HAPPENS_AFTER</computeroutput>. See
+ e.g. the output of the following command for an example:
+ <computeroutput>valgrind --tool=drd --free-is-write=yes
+ drd/tests/annotate_smart_pointer</computeroutput>.
+ </para>
+ </listitem>
+ </itemizedlist>
</listitem>
</varlistentry>
<varlistentry>
Modified: trunk/memcheck/docs/mc-manual.xml
==============================================================================
--- trunk/memcheck/docs/mc-manual.xml (original)
+++ trunk/memcheck/docs/mc-manual.xml Thu Dec 12 23:19:13 2013
@@ -718,22 +718,21 @@
</term>
<listitem>
<para>Specifies the leak kinds to show in a full leak search, in
- one of the following ways:
+ one of the following ways: </para>
- <itemizedlist>
- <listitem><para>a comma separated list of one or more of
+ <itemizedlist>
+ <listitem><para>a comma separated list of one or more of
<option>definite indirect possible reachable</option>.</para>
- </listitem>
-
- <listitem><para><option>all</option> to specify the complete set (all leak kinds).
+ </listitem>
+
+ <listitem><para><option>all</option> to specify the complete set (all leak kinds).
It is equivalent to
<option>--show-leak-kinds=definite,indirect,possible,reachable</option>.</para>
- </listitem>
-
- <listitem><para><option>none</option> for the empty set.</para>
- </listitem>
- </itemizedlist>
- </para>
+ </listitem>
+
+ <listitem><para><option>none</option> for the empty set.</para>
+ </listitem>
+ </itemizedlist>
</listitem>
</varlistentry>
@@ -757,32 +756,30 @@
</term>
<listitem>
<para>Specifies the set of leak check heuristics to be used
- during
- leak searches. The heuristics control which interior pointers
+ during leak searches. The heuristics control which interior pointers
to a block cause it to be considered as reachable.
- The heuristic set is specified in one of the following ways:
+ The heuristic set is specified in one of the following ways:</para>
- <itemizedlist>
- <listitem><para>a comma separated list of one or more of
+ <itemizedlist>
+ <listitem><para>a comma separated list of one or more of
<option>stdstring newarray multipleinheritance</option>.</para>
- </listitem>
+ </listitem>
- <listitem><para><option>all</option> to activate the complete set of
+ <listitem><para><option>all</option> to activate the complete set of
heuristics.
It is equivalent to
<option>--leak-check-heuristics=stdstring,newarray,multipleinheritance</option>.</para>
- </listitem>
-
- <listitem><para><option>none</option> for the empty set.</para>
- </listitem>
- </itemizedlist>
- </para>
+ </listitem>
+
+ <listitem><para><option>none</option> for the empty set.</para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
- <para>Note that these heuristics are dependent on the layout of the objects
+ <para>Note that these heuristics are dependent on the layout of the objects
produced by the C++ compiler. They have been tested with some gcc versions
(e.g. 4.4 and 4.7). They might not work properly with other C++ compilers.
- </para>
- </listitem>
+ </para>
</varlistentry>
@@ -795,30 +792,30 @@
</term>
<listitem>
<para>These options provide an alternative way to specify the leak kinds to show:
- <itemizedlist>
- <listitem>
- <para>
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
<option>--show-reachable=no --show-possibly-lost=yes</option> is equivalent to
<option>--show-leak-kinds=definite,possible</option>.
- </para>
- </listitem>
- <listitem>
- <para>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
<option>--show-reachable=no --show-possibly-lost=no</option> is equivalent to
<option>--show-leak-kinds=definite</option>.
- </para>
- </listitem>
- <listitem>
- <para>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
<option>--show-reachable=yes</option> is equivalent to
<option>--show-leak-kinds=all</option>.
- Note that <option>--show-possibly-lost=no</option> has no effect
- if <option>--show-reachable=yes</option> is specified.
- </para>
- </listitem>
- </itemizedlist>
- </para>
+ </para>
+ </listitem>
+ </itemizedlist>
</listitem>
+ <para> Note that <option>--show-possibly-lost=no</option> has no effect
+ if <option>--show-reachable=yes</option> is specified.</para>
</varlistentry>
<varlistentry id="opt.undef-value-errors" xreflabel="--undef-value-errors">
|