|
From: Philippe W. <phi...@so...> - 2019-01-27 11:34:52
|
https://sourceware.org/git/gitweb.cgi?p=valgrind.git;h=423c75404928442e76eb1f586ff83dea8ae3ef1e commit 423c75404928442e76eb1f586ff83dea8ae3ef1e Author: Philippe Waroquiers <phi...@sk...> Date: Sun Jan 27 12:32:32 2019 +0100 Update callgrind_annotate documentation. Clarify the meaning of the threshold argument. Document the per event thresholds that can be given as part of the --sort option. Diff: --- callgrind/docs/cl-manual.xml | 22 +++++++++++++++------- 1 file changed, 15 insertions(+), 7 deletions(-) diff --git a/callgrind/docs/cl-manual.xml b/callgrind/docs/cl-manual.xml index 1b04e1d..c1eb6ea 100644 --- a/callgrind/docs/cl-manual.xml +++ b/callgrind/docs/cl-manual.xml @@ -1253,22 +1253,30 @@ their arguments.</para> <varlistentry> <term> - <option>--sort=A,B,C</option> + <option><![CDATA[--threshold=<0--100> [default: 99%] ]]></option> </term> <listitem> - <para>Sort columns by events A,B,C [event column order].</para> - <para>Optionally, each event is followed by a : and a threshold, - to specify different thresholds depending on the event.</para> + <para>Percentage of counts (of primary sort event) we are + interested in.</para> + <para>callgrind_annotate stops printing functions when the sum + of the cost percentage of the printed functions is bigger or equal + to the given threshold percentage.</para> </listitem> </varlistentry> <varlistentry> <term> - <option><![CDATA[--threshold=<0--100> [default: 99%] ]]></option> + <option>--sort=A,B,C</option> </term> <listitem> - <para>Percentage of counts (of primary sort event) we are - interested in.</para> + <para>Sort columns by events A,B,C [event column order].</para> + <para>Optionally, each event is followed by a : and a threshold, + to specify different thresholds depending on the event.</para> + <para>callgrind_annotate stops printing functions when the sum + of the cost percentage of the printed functions for all the events + is bigger or equal to the given event threshold percentages.</para> + <para>When one or more thresholds are given via this option, + the value of <option>--threshold</option> is ignored.</para> </listitem> </varlistentry> |