From: Nicholas Nethercote <njn@valgrind.org>
Date: Fri, 10 Jul 2009 08:16:29 +0000 (+0000)
Subject: Make --leak-resolution=high the default.  Fixes bug 197929.
X-Git-Tag: svn/VALGRIND_3_5_0~424
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=7e075c243ff68422f387816d457caef102cc8412;p=thirdparty%2Fvalgrind.git

Make --leak-resolution=high the default.  Fixes bug 197929.



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

diff --git a/NEWS b/NEWS
index 00a5d5ccee..3e2c18d4a6 100644
--- a/NEWS
+++ b/NEWS
@@ -41,6 +41,10 @@ Release 3.5.0 (???)
   - Blocks that are only reachable via at least one interior-pointer, but
     are directly pointed to by a start-pointer, were previously marked as
     "still reachable".  They are now correctly marked as "possibly lost".
+  - The default value for the --leak-resolution option has been changed from
+    "low" to "high".  In general, this means that more leak reports will be
+    produced, but each leak report will describe fewer leaked blocks.
+  - The documentation for the leak checker has also been improved.
 
 * The format of some (non-XML) stack trace entries has changed a little.
   Previously there were six possible forms:
diff --git a/memcheck/docs/mc-manual.xml b/memcheck/docs/mc-manual.xml
index 32c63083b3..42369ed208 100644
--- a/memcheck/docs/mc-manual.xml
+++ b/memcheck/docs/mc-manual.xml
@@ -163,7 +163,7 @@ problems:</para>
 
   <varlistentry id="opt.leak-resolution" xreflabel="--leak-resolution">
     <term>
-      <option><![CDATA[--leak-resolution=<low|med|high> [default: low] ]]></option>
+      <option><![CDATA[--leak-resolution=<low|med|high> [default: high] ]]></option>
     </term>
     <listitem>
       <para>When doing leak checking, determines how willing
@@ -171,13 +171,12 @@ problems:</para>
       be the same.  When set to <varname>low</varname>, only the first
       two entries need match.  When <varname>med</varname>, four entries
       have to match.  When <varname>high</varname>, all entries need to
-      match.</para>
+      match;  this is consistent with how merging occurs for other kinds of
+      errors.</para>
 
       <para>For hardcore leak debugging, you probably want to use
       <option>--leak-resolution=high</option> together with
-      <option>--num-callers=40</option> or some such large number.  Note
-      however that this can give an overwhelming amount of information,
-      which is why the defaults give less information.
+      <option>--num-callers=40</option> or some such large number.
       </para>
 
       <para>Note that the <option>--leak-resolution=</option> setting
diff --git a/memcheck/mc_main.c b/memcheck/mc_main.c
index a6660ad4b4..63c002cda5 100644
--- a/memcheck/mc_main.c
+++ b/memcheck/mc_main.c
@@ -4656,7 +4656,7 @@ static Bool mc_expensive_sanity_check ( void )
 Bool          MC_(clo_partial_loads_ok)       = False;
 Long          MC_(clo_freelist_vol)           = 10*1000*1000LL;
 LeakCheckMode MC_(clo_leak_check)             = LC_Summary;
-VgRes         MC_(clo_leak_resolution)        = Vg_LowRes;
+VgRes         MC_(clo_leak_resolution)        = Vg_HighRes;
 Bool          MC_(clo_show_reachable)         = False;
 Bool          MC_(clo_workaround_gcc296_bugs) = False;
 Int           MC_(clo_malloc_fill)            = -1;
@@ -4774,7 +4774,7 @@ static void mc_print_usage(void)
 {  
    VG_(printf)(
 "    --leak-check=no|summary|full     search for memory leaks at exit?  [summary]\n"
-"    --leak-resolution=low|med|high   how much bt merging in leak check [low]\n"
+"    --leak-resolution=low|med|high   differentiation of leak stack traces [high]\n"
 "    --show-reachable=no|yes          show reachable blocks in leak check? [no]\n"
 "    --undef-value-errors=no|yes      check for undefined value errors [yes]\n"
 "    --track-origins=no|yes           show origins of undefined values? [no]\n"