xtree: some documentation and --help-debug fine tuning

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

diff --git a/NEWS b/NEWS
index 188721203ba3f1540730c38713cbc5a12ee0d217..e1bcf64b14b703bccb1f42051b31320ea601fc0b 100644 (file)
--- a/NEWS
+++ b/NEWS
@@ -12,19 +12,19 @@ MIPS32/Android, X86/Android, X86/Solaris, AMD64/Solaris, X86/MacOSX
 10.10 and AMD64/MacOSX 10.10.  There is also preliminary support for
 X86/MacOSX 10.11/12, AMD64/MacOSX 10.11/12 and TILEGX/Linux.
 
-A significant change in 3.13 is the addition of the 'xtree' concept:
-An xtree is a tree of stacktraces with data associated to the stacktraces.
-This xtree is used by various tools (memcheck, helgrind, massif) to
-report the heap consumption of your program. The xtree reporting
-is controlled by the new options --xtree-memory=none|allocs|full and
---xtree-memory-file=<file>.
-An heap xtree memory profiling can also be produced on demand using
-a gdbserver monitor command.
-The xtree can be output in 2 formats: 'callgrind format'
-and 'massif format. The existing visualisers for these formats (e.g.
-callgrind_annotate, kcachegrind, ms_print) can be used to visualise
-and analyse these reports.
-For more details, read the user manual.
+* The 'xtree concept' was added in 3.13:
+   An xtree is a tree of stacktraces with data associated to the stacktraces.
+   This xtree is used by various tools (memcheck, helgrind, massif) to
+   report the heap consumption of your program. The xtree reporting
+   is controlled by the new options --xtree-memory=none|allocs|full and
+   --xtree-memory-file=<file>.
+   An heap xtree memory profiling can also be produced on demand using
+   the gdbserver monitor command 'xtmemory [<filename>]>'.
+   The xtree can be output in 2 formats: 'callgrind format'
+   and 'massif format. The existing visualisers for these formats (e.g.
+   callgrind_annotate, kcachegrind, ms_print) can be used to visualise
+   and analyse these reports.
+   For more details, read the user manual.
 
 * ================== PLATFORM CHANGES =================
 
@@ -32,28 +32,18 @@ For more details, read the user manual.
 
 * Memcheck:
 
-  - Support for --xtree-memory profiling.
-  
-  - A new monitor command 'xtmemory [<filename>]>' produces a
-    heap usage profile report.
+  - Support for --xtree-memory and 'xtmemory [<filename>]>'.
 
 * Massif:
 
-  - Support for --xtree-memory profiling.
-  
-  - A new monitor command 'xtmemory [<filename>]>' produces a
-    heap usage profile report.
+  - Support for --xtree-memory and 'xtmemory [<filename>]>'.
 
   - For some workloads (typically, for big applications), Massif
     memory consumption and CPU consumption decreases significantly.
 
 * Helgrind:
 
-  - Support for --xtree-memory profiling.
-  
-  - A new monitor command 'xtmemory [<filename>]>' produces a
-    heap usage profile report.
-
+  - Support for --xtree-memory and 'xtmemory [<filename>]>'.
 
 
 * ==================== OTHER CHANGES ====================
@@ -62,6 +52,7 @@ For more details, read the user manual.
   will append the inner guest stacktrace to the inner host stacktrace.
   This helps to investigate the errors reported by the outer, when they
   are caused by the inner guest program (such as an inner regtest).
+  See README_DEVELOPERS for more info.
 
 * ==================== FIXED BUGS ====================
 

diff --git a/coregrind/m_main.c b/coregrind/m_main.c
index cd3d7c5c8a2aa30e311d95e9b359d93ed06ec1b4..daa08d691ade8bd9950ad4534c4af087cae8fea6 100644 (file)
--- a/coregrind/m_main.c
+++ b/coregrind/m_main.c
@@ -294,6 +294,7 @@ static void usage_NORETURN ( Bool debug_help )
 "\n"
 "  debugging options for Valgrind tools that replace malloc:\n"
 "    --trace-malloc=no|yes     show client malloc details? [no]\n"
+"    --xtree-compress-strings=no|yes   compress strings in xtree callgrind format [yes]\n"
 "\n";
 
    const HChar usage3[] =

diff --git a/helgrind/docs/hg-manual.xml b/helgrind/docs/hg-manual.xml
index 28d4d9b482af4aa0939d7a8b92b228465207a384..ff7d65bdce95f8f28f89b65610d24faa573f013c 100644 (file)
--- a/helgrind/docs/hg-manual.xml
+++ b/helgrind/docs/hg-manual.xml
@@ -64,6 +64,11 @@ primitives, you can describe their behaviour to Helgrind using the
 <varname>ANNOTATE_*</varname> macros defined
 in <varname>helgrind.h</varname>.</para>
 
+<para>Helgrind also provides <xref linkend="manual-core.xtree"/> memory
+  profiling using the command line
+  option <computeroutput>--xtree-memory</computeroutput> and the monitor command
+   <computeroutput>xtmemory</computeroutput>.</para>
+
 
 
 <para>Following those is a section containing 

diff --git a/massif/docs/ms-manual.xml b/massif/docs/ms-manual.xml
index 4c555a97025fa4c64edd5b50716d5e3816a57e95..b33033509ee4fe48f29dfb281375daf8a4e074ac 100644 (file)
--- a/massif/docs/ms-manual.xml
+++ b/massif/docs/ms-manual.xml
@@ -46,6 +46,11 @@ program is using, it also gives very detailed information that indicates
 which parts of your program are responsible for allocating the heap memory.
 </para>
 
+<para>Massif also provides <xref linkend="manual-core.xtree"/> memory
+  profiling using the command line
+  option <computeroutput>--xtree-memory</computeroutput> and the monitor command
+   <computeroutput>xtmemory</computeroutput>.</para>
+
 </sect1>
 
 

diff --git a/memcheck/docs/mc-manual.xml b/memcheck/docs/mc-manual.xml
index 0fdd266d6da9ab487a96bf29b4cf94c991584b0e..084773a377a729ea2ca8496b0842cb425dc65769 100644 (file)
--- a/memcheck/docs/mc-manual.xml
+++ b/memcheck/docs/mc-manual.xml
@@ -57,8 +57,12 @@ problems that are common in C and C++ programs.</para>
 
 <para>Problems like these can be difficult to find by other means,
 often remaining undetected for long periods, then causing occasional,
-difficult-to-diagnose crashes.</para>
+  difficult-to-diagnose crashes.</para>
 
+<para>Memcheck also provides <xref linkend="manual-core.xtree"/> memory
+  profiling using the command line
+  option <computeroutput>--xtree-memory</computeroutput> and the monitor command
+   <computeroutput>xtmemory</computeroutput>.</para>
 </sect1>
 
 
@@ -1040,6 +1044,13 @@ is <option>--errors-for-leak-kinds=definite,possible</option>
       and/or by using a smaller value for the
       option <varname>--num-callers</varname>.
       </para>
+      
+      <para>If you want to use
+        <computeroutput>--xtree-memory=full</computeroutput> memory profiling
+        (see <xref linkend="manual-core.xtree"/> ), then you cannot
+        specify <varname>--keep-stacktraces=free</varname>
+        or <varname>--keep-stacktraces=none</varname>.</para>
+
     </listitem>
   </varlistentry>
 

diff --git a/none/tests/cmdline2.stdout.exp b/none/tests/cmdline2.stdout.exp
index 7265c2b9e106ef19b5f43436bc056c432c096481..644013c47e7ba74e1c67a2cb5857c28ab590ed46 100644 (file)
--- a/none/tests/cmdline2.stdout.exp
+++ b/none/tests/cmdline2.stdout.exp
@@ -205,6 +205,7 @@ usage: valgrind [options] prog-and-args
 
   debugging options for Valgrind tools that replace malloc:
     --trace-malloc=no|yes     show client malloc details? [no]
+    --xtree-compress-strings=no|yes   compress strings in xtree callgrind format [yes]
 
   debugging options for Nulgrind:
     (none)