[PATCH v14 09/23] perf config: Document variables for 'report' section in man page

From: Taeung Song
Date: Mon Jan 11 2016 - 09:42:58 EST


Explain 'report' section's variables.

'percent-limit', 'queue-size' and 'children'.

Cc: Namhyung Kim <namhyung@xxxxxxxxxx>
Cc: Jiri Olsa <jolsa@xxxxxxxxxx>
Signed-off-by: Taeung Song <treeze.taeung@xxxxxxxxx>
---
tools/perf/Documentation/perf-config.txt | 34 ++++++++++++++++++++++++++++++++
1 file changed, 34 insertions(+)

diff --git a/tools/perf/Documentation/perf-config.txt b/tools/perf/Documentation/perf-config.txt
index 2f965e0..ef4d68f 100644
--- a/tools/perf/Documentation/perf-config.txt
+++ b/tools/perf/Documentation/perf-config.txt
@@ -372,6 +372,40 @@ call-graph.*::
This is a maximum number of lines of callchain printed for a single
histogram entry. Default is 0 which means no limitation.

+report.*::
+ report.percent-limit::
+ This one is mostly same as call-graph.threshold but works for
+ histogram entries. Entries have overhead lower than this percentage
+ will not be printed. Default is 0. If percent-limit is 10,
+ entries which have more than 10% of overhead will be printed only.
+
+ report.queue-size::
+ This option is to setup the maximum allocation size of internal
+ event queue for ordering events. Default is 0, meaning no limit.
+
+ report.children::
+ The children means that functions called from another function.
+ If this option is true, perf report cumulates callchains of children
+ and show (accumulated) total overhead as well as self overhead.
+ Please refer to the perf-report manual. The default is true.
+
+ report.group::
+ This option is to show event group information together.
+ If it is 'true', event group view can be enabled by default i.e.
+
+ # group: {ref-cycles,cycles}
+ # ========
+ #
+ # Samples: 7K of event 'anon group { ref-cycles, cycles }'
+ # Event count (approx.): 6876107743
+ #
+ # Overhead Command Shared Object Symbol
+ # ................ ....... ................. ..........................
+ #
+ 99.84% 99.76% noploop noploop [.] main
+ 0.07% 0.00% noploop ld-2.15.so [.] strcmp
+ 0.03% 0.00% noploop [kernel.kallsyms] [k] timerqueue_del
+
SEE ALSO
--------
linkperf:perf[1]
--
2.5.0