linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Arnaldo Carvalho de Melo <acme@kernel.org>
To: Ingo Molnar <mingo@kernel.org>
Cc: linux-kernel@vger.kernel.org, Yannick Brosseau <scientist@fb.com>,
	Namhyung Kim <namhyung@kernel.org>,
	Peter Zijlstra <peterz@infradead.org>,
	kernel-team@fb.com, Arnaldo Carvalho de Melo <acme@redhat.com>
Subject: [PATCH 10/10] perf tools: Explicitly document that --children is enabled by default
Date: Wed,  7 Dec 2016 13:53:35 -0300	[thread overview]
Message-ID: <20161207165335.22835-11-acme@kernel.org> (raw)
In-Reply-To: <20161207165335.22835-1-acme@kernel.org>

From: Yannick Brosseau <scientist@fb.com>

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@fb.com>
Cc: Namhyung Kim <namhyung@kernel.org>
Cc: Peter Zijlstra <peterz@infradead.org>
Cc: kernel-team@fb.com
Link: http://lkml.kernel.org/r/20161202160732.29058-1-scientist@fb.com
Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.com>
---
 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 3a166ae4a4d3..f2914f03ae7b 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 91d638df3a6b..e71d63843f45 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.9.3

  parent reply	other threads:[~2016-12-07 16:58 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-12-07 16:53 [GIT PULL 00/10] perf/core improvements and fixes Arnaldo Carvalho de Melo
2016-12-07 16:53 ` [PATCH 01/10] perf build: Check LLVM version in feature check Arnaldo Carvalho de Melo
2016-12-07 16:53 ` [PATCH 02/10] perf tools: Move PERF-VERSION-FILE target into rules area Arnaldo Carvalho de Melo
2016-12-07 16:53 ` [PATCH 03/10] perf tools: Force fixdep compilation at the start of the build Arnaldo Carvalho de Melo
2016-12-07 16:53 ` [PATCH 04/10] perf tools: Move perf build related variables under non fixdep leg Arnaldo Carvalho de Melo
2016-12-07 16:53 ` [PATCH 05/10] perf sched timehist: Improve error message when analyzing wrong file Arnaldo Carvalho de Melo
2016-12-07 16:53 ` [PATCH 06/10] perf sched: Cleanup option processing Arnaldo Carvalho de Melo
2016-12-07 16:53 ` [PATCH 07/10] perf callchain: Introduce callchain_cursor__copy() Arnaldo Carvalho de Melo
2016-12-07 16:53 ` [PATCH 08/10] perf sched timehist: Handle zero sample->tid properly Arnaldo Carvalho de Melo
2016-12-07 16:53 ` [PATCH 09/10] perf sched timehist: Cleanup idle_max_cpu handling Arnaldo Carvalho de Melo
2016-12-07 16:53 ` Arnaldo Carvalho de Melo [this message]
2016-12-07 18:17 ` [GIT PULL 00/10] perf/core improvements and fixes Ingo Molnar

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20161207165335.22835-11-acme@kernel.org \
    --to=acme@kernel.org \
    --cc=acme@redhat.com \
    --cc=kernel-team@fb.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mingo@kernel.org \
    --cc=namhyung@kernel.org \
    --cc=peterz@infradead.org \
    --cc=scientist@fb.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).