From 423c75404928442e76eb1f586ff83dea8ae3ef1e Mon Sep 17 00:00:00 2001 From: Philippe Waroquiers Date: Sun, 27 Jan 2019 12:32:32 +0100 Subject: [PATCH] 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. --- 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 1b04e1d68b..c1eb6ea355 100644 --- a/callgrind/docs/cl-manual.xml +++ b/callgrind/docs/cl-manual.xml @@ -1253,22 +1253,30 @@ their arguments. - + - Sort columns by events A,B,C [event column order]. - Optionally, each event is followed by a : and a threshold, - to specify different thresholds depending on the event. + Percentage of counts (of primary sort event) we are + interested in. + 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. - + - Percentage of counts (of primary sort event) we are - interested in. + Sort columns by events A,B,C [event column order]. + Optionally, each event is followed by a : and a threshold, + to specify different thresholds depending on the event. + 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. + When one or more thresholds are given via this option, + the value of is ignored. -- 2.47.2