Re: [PATCH v11 11/24] perf config: Document variables for 'report' section in man page

[Namhyung Kim <namhyung@kernel.org>]

On Tue, Nov 17, 2015 at 10:53:31PM +0900, Taeung Song wrote:
> Explain 'report' section's variables.
> 
> 'percent-limit', 'queue-size' and 'children'.
> 
> Cc: Namhyung Kim <namhyung@kernel.org>
> Cc: Jiri Olsa <jolsa@redhat.com>
> Signed-off-by: Taeung Song <treeze.taeung@gmail.com>
> ---
>  tools/perf/Documentation/perf-config.txt | 17 +++++++++++++++++
>  1 file changed, 17 insertions(+)
> 
> diff --git a/tools/perf/Documentation/perf-config.txt b/tools/perf/Documentation/perf-config.txt
> index dc659d6..b9f89dd 100644
> --- a/tools/perf/Documentation/perf-config.txt
> +++ b/tools/perf/Documentation/perf-config.txt
> @@ -350,6 +350,23 @@ call-graph.*::
>  		This is another way to control the number of callchains printed for a
>  		single 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 70, the output which has percentages of
> +		each overhead above 70% can be printed.

70% is an unrealistric example IMHO. :)  How about this?

		If percent-limit is 10, entries which have more than 10% of overhead
		will be printed only.

> +
> +	report.queue-size::
> +		option to setup the maximum allocation size for session's
> +		ordered events queue, if not set there's no default limit.

		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 the option is true, accumulate callchain of children and show total overhead.

		If this option is true, perf report cumulates callchains of children
		and show (accumulated) total overhead as well as self overhead.

Thanks,
Namhyung


> +		Please refer to the perf-report manual. The default is true.
> +
>  SEE ALSO
>  --------
>  linkperf:perf[1]
> -- 
> 1.9.1
>