From: Bart Van Assche <bvanassche@acm.org>
Date: Thu, 10 Dec 2009 17:58:46 +0000 (+0000)
Subject: Made the description of DRD_TRACE_VAR(), ANNOTATE_TRACE_MEMORY() and
X-Git-Tag: svn/VALGRIND_3_6_0~451
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=a1bfeb7704061a7e9ebf2425ed357973a56ca6c6;p=thirdparty%2Fvalgrind.git

Made the description of DRD_TRACE_VAR(), ANNOTATE_TRACE_MEMORY() and
VG_USERREQ__DRD_START_TRACE_ADDR more clear.


git-svn-id: svn://svn.valgrind.org/valgrind/trunk@10965
---

diff --git a/drd/docs/drd-manual.xml b/drd/docs/drd-manual.xml
index 318a750b12..076e084019 100644
--- a/drd/docs/drd-manual.xml
+++ b/drd/docs/drd-manual.xml
@@ -923,14 +923,26 @@ available macros and client requests are:
   </listitem>
   <listitem>
     <para>
-      The macros <literal>DRD_TRACE_VAR(x)</literal>,
-      <literal>ANNOTATE_TRACE_MEMORY(&amp;x)</literal>
-      and the corresponding client request
-      <varname>VG_USERREQ__DRD_START_TRACE_ADDR</varname>. Trace all
-      load and store activity on the specified address range. When DRD reports
-      a data race on a specified variable, and it's not immediately clear
-      which source code statements triggered the conflicting accesses, it can
-      be very helpful to trace all activity on the offending memory location.
+      The macro <literal>DRD_TRACE_VAR(x)</literal>. Trace all load and store
+      activity for the address range starting at <literal>&amp;x</literal> and
+      occupying <literal>sizeof(x)</literal> bytes. When DRD reports a data
+      race on a specified variable, and it's not immediately clear which
+      source code statements triggered the conflicting accesses, it can be
+      very helpful to trace all activity on the offending memory location.
+    </para>
+  </listitem>
+  <listitem>
+    <para>
+      The macro <literal>ANNOTATE_TRACE_MEMORY(&amp;x)</literal>. Trace all
+      load and store activity that touches at least the single byte at the
+      address <literal>&amp;x</literal>.
+    </para>
+  </listitem>
+  <listitem>
+    <para>
+      The client request <varname>VG_USERREQ__DRD_START_TRACE_ADDR</varname>,
+      which allows to trace all load and store activity for the specified
+      address range.
     </para>
   </listitem>
   <listitem>