Document that --xml=yes automatically activates --leak-check=full

LouisBrunner · Jun 2, 2019 · 4dec2cd · 4dec2cd
1 parent 9616e9b
commit 4dec2cd
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/memcheck/docs/mc-manual.xml b/memcheck/docs/mc-manual.xml
@@ -747,6 +747,11 @@ is <option>--errors-for-leak-kinds=definite,possible</option>
       in detail and/or counted as an error, as specified by the options 
       <option>--show-leak-kinds</option> and 
       <option>--errors-for-leak-kinds</option>. </para>
+      <para>If <varname>--xml=yes</varname> is given, memcheck will
+      automatically use the value <varname>--leak-check=full</varname>.
+      You can use <option>--show-leak-kinds=none</option> to reduce
+      the size of the xml output if you are not interested in the leak
+      results.</para>
     </listitem>
   </varlistentry>