[tip:perf/core] perf tools: Explicitly document that --children is enabled by default

From: tip-bot for Yannick Brosseau
Date: Wed Dec 07 2016 - 13:27:41 EST


Commit-ID: 108a7c103b761309ccbd997002e8428808cf1e04
Gitweb: http://git.kernel.org/tip/108a7c103b761309ccbd997002e8428808cf1e04
Author: Yannick Brosseau <scientist@xxxxxx>
AuthorDate: Fri, 2 Dec 2016 11:07:32 -0500
Committer: Arnaldo Carvalho de Melo <acme@xxxxxxxxxx>
CommitDate: Wed, 7 Dec 2016 12:00:35 -0300

perf tools: Explicitly document that --children is enabled by default

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

Signed-off-by: Yannick Brosseau <scientist@xxxxxx>
Cc: Namhyung Kim <namhyung@xxxxxxxxxx>
Cc: Peter Zijlstra <peterz@xxxxxxxxxxxxx>
Cc: kernel-team@xxxxxx
Link: http://lkml.kernel.org/r/20161202160732.29058-1-scientist@xxxxxx
Signed-off-by: Arnaldo Carvalho de Melo <acme@xxxxxxxxxx>
---
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 3a166ae..f2914f0 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