Re: [PATCH] perf tools: Explicitly document that --children is enabled by default

From: Arnaldo Carvalho de Melo
Date: Tue Dec 06 2016 - 14:45:51 EST


Em Fri, Dec 02, 2016 at 11:07:32AM -0500, Yannick Brosseau escreveu:
> The fact that the --children option is enabled by default is buried deep
> at the end of the help page, in the overhead calculation section. This
> make it explicit right where the option is listed, following the same
> way other default options are described

Thanks, applied.

- Arnaldo

> Signed-off-by: Yannick Brosseau <scientist@xxxxxx>
> ---
> tools/perf/Documentation/perf-report.txt | 3 ++-
> tools/perf/Documentation/perf-top.txt | 1 +
> 2 files changed, 3 insertions(+), 1 deletion(-)
>
> diff --git a/tools/perf/Documentation/perf-report.txt b/tools/perf/Documentation/perf-report.txt
> index 2d17462..aaa8011 100644
> --- a/tools/perf/Documentation/perf-report.txt
> +++ b/tools/perf/Documentation/perf-report.txt
> @@ -239,7 +239,8 @@ OPTIONS
> Accumulate callchain of children to parent entry so that then can
> show up in the output. The output will have a new "Children" column
> and will be sorted on the data. It requires callchains are recorded.
> - See the `overhead calculation' section for more details.
> + See the `overhead calculation' section for more details. Enabled by
> + default, disable with --no-children.
>
> --max-stack::
> Set the stack depth limit when parsing the callchain, anything
> diff --git a/tools/perf/Documentation/perf-top.txt b/tools/perf/Documentation/perf-top.txt
> index 91d638d..e71d638 100644
> --- a/tools/perf/Documentation/perf-top.txt
> +++ b/tools/perf/Documentation/perf-top.txt
> @@ -170,6 +170,7 @@ Default is to monitor all CPUS.
> show up in the output. The output will have a new "Children" column
> and will be sorted on the data. It requires -g/--call-graph option
> enabled. See the `overhead calculation' section for more details.
> + Enabled by default, disable with --no-children.
>
> --max-stack::
> Set the stack depth limit when parsing the callchain, anything
> --
> 2.10.2