From: Philippe Waroquiers <philippe.waroquiers@skynet.be>
Date: Sun, 23 Dec 2018 22:44:54 +0000 (+0100)
Subject: Document the new options --show-error-list and -s
X-Git-Tag: VALGRIND_3_15_0~106
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=9efc7e80f223e2620f18a92eee813012519c7c3a;p=thirdparty%2Fvalgrind.git

Document the new options --show-error-list and -s
---

diff --git a/docs/xml/manual-core.xml b/docs/xml/manual-core.xml
index e3c2a83afc..d2ab7e28d3 100644
--- a/docs/xml/manual-core.xml
+++ b/docs/xml/manual-core.xml
@@ -1226,6 +1226,34 @@ that can report errors, e.g. Memcheck, but not Cachegrind.</para>
     </listitem>
   </varlistentry>
 
+  <varlistentry id="opt.show-error-list" xreflabel="--show-error-list">
+    <term>
+      <option><![CDATA[--show-error-list=no|yes [default: no]]]></option>
+    </term>
+    <listitem>
+      <para>If this option is enabled, for tools that report errors, valgrind
+        will show the list of detected errors and the list of used suppressions
+        at exit.
+      </para>
+      <para>Note that at verbosity 2 and above, valgrind automatically shows
+        the list of detected errors and the list of used suppressions
+        at exit, unless  <option>--show-error-list=no</option> is selected.
+      </para>
+    </listitem>
+  </varlistentry>
+
+    <varlistentry id="opt.s" xreflabel="-s">
+    <term>
+      <option><![CDATA[-s]]></option>
+    </term>
+    <listitem>
+      <para>Specifying <option>-s</option> is equivalent to
+        <option>--show-error-list=yes</option>.
+      </para>
+    </listitem>
+  </varlistentry>
+
+  
   <varlistentry id="opt.sigill-diagnostics" xreflabel="--sigill-diagnostics">
     <term>
       <option><![CDATA[--sigill-diagnostics=<yes|no> [default: yes] ]]></option>