linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Ravi Bangoria <ravi.bangoria@linux.ibm.com>
To: acme@kernel.org, jolsa@redhat.com
Cc: xieyisheng1@huawei.com, alexey.budankov@linux.intel.com,
	treeze.taeung@gmail.com, adrian.hunter@intel.com,
	tmricht@linux.ibm.com, namhyung@kernel.org, irogers@google.com,
	songliubraving@fb.com, yao.jin@linux.intel.com,
	changbin.du@intel.com, leo.yan@linaro.org,
	linux-kernel@vger.kernel.org,
	Ravi Bangoria <ravi.bangoria@linux.ibm.com>
Subject: [PATCH 7/8] perf annotate: Fix perf config option description
Date: Thu, 13 Feb 2020 12:13:05 +0530	[thread overview]
Message-ID: <20200213064306.160480-8-ravi.bangoria@linux.ibm.com> (raw)
In-Reply-To: <20200213064306.160480-1-ravi.bangoria@linux.ibm.com>

perf config annotate options says it works only with TUI, which is wrong.
Most of the TUI options are applicable to stdio2 as well. So remove that
generic line and add individual line with each option stating which
browsers supports that option. Also, annotate.show_nr_samples config is
missing in Documentation. Describe it.

Signed-off-by: Ravi Bangoria <ravi.bangoria@linux.ibm.com>
---
 tools/perf/Documentation/perf-config.txt | 30 +++++++++++++++++++++++-
 1 file changed, 29 insertions(+), 1 deletion(-)

diff --git a/tools/perf/Documentation/perf-config.txt b/tools/perf/Documentation/perf-config.txt
index c4dd23c4b478..9dae0df3ab7e 100644
--- a/tools/perf/Documentation/perf-config.txt
+++ b/tools/perf/Documentation/perf-config.txt
@@ -239,7 +239,6 @@ buildid.*::
 		set buildid.dir to /dev/null. The default is $HOME/.debug
 
 annotate.*::
-	These options work only for TUI.
 	These are in control of addresses, jump function, source code
 	in lines of assembly code from a specific program.
 
@@ -269,6 +268,8 @@ annotate.*::
 		│        mov    (%rdi),%rdx
 		│              return n;
 
+		This option works with tui, stdio2 browsers.
+
         annotate.use_offset::
 		Basing on a first address of a loaded function, offset can be used.
 		Instead of using original addresses of assembly code,
@@ -287,6 +288,8 @@ annotate.*::
 
 		             368:│  mov    0x8(%r14),%rdi
 
+		This option works with tui, stdio2 browsers.
+
 	annotate.jump_arrows::
 		There can be jump instruction among assembly code.
 		Depending on a boolean value of jump_arrows,
@@ -306,6 +309,8 @@ annotate.*::
 		│1330:   mov    %r15,%r10
 		│1333:   cmp    %r15,%r14
 
+		This option works with tui browser.
+
         annotate.show_linenr::
 		When showing source code if this option is 'true',
 		line numbers are printed as below.
@@ -325,6 +330,8 @@ annotate.*::
 		│                     array++;
 		│             }
 
+		This option works with tui, stdio2 browsers.
+
         annotate.show_nr_jumps::
 		Let's see a part of assembly code.
 
@@ -335,6 +342,8 @@ annotate.*::
 
 		│1 1382:   movb   $0x1,-0x270(%rbp)
 
+		This option works with tui, stdio2 browsers.
+
         annotate.show_total_period::
 		To compare two records on an instruction base, with this option
 		provided, display total number of samples that belong to a line
@@ -348,11 +357,30 @@ annotate.*::
 
 		99.93 │      mov    %eax,%eax
 
+		This option works with tui, stdio2, stdio browsers.
+
+	annotate.show_nr_samples::
+		By default perf annotate shows percentage of samples. This option
+		can be used to print absolute number of samples. Ex, when set as
+		false:
+
+		Percent│
+		 74.03 │      mov    %fs:0x28,%rax
+
+		When set as true:
+
+		Samples│
+		     6 │      mov    %fs:0x28,%rax
+
+		This option works with tui, stdio2, stdio browsers.
+
 	annotate.offset_level::
 		Default is '1', meaning just jump targets will have offsets show right beside
 		the instruction. When set to '2' 'call' instructions will also have its offsets
 		shown, 3 or higher will show offsets for all instructions.
 
+		This option works with tui, stdio2 browsers.
+
 hist.*::
 	hist.percentage::
 		This option control the way to calculate overhead of filtered entries -
-- 
2.24.1


  parent reply	other threads:[~2020-02-13  6:44 UTC|newest]

Thread overview: 26+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-02-13  6:42 [PATCH 0/8] perf annotate/config: More fixes Ravi Bangoria
2020-02-13  6:42 ` [PATCH 1/8] perf annotate/tui: Re-render title bar after switching back from script browser Ravi Bangoria
2020-02-27 13:11   ` Arnaldo Carvalho de Melo
2020-02-29  9:16   ` [tip: perf/urgent] " tip-bot2 for Ravi Bangoria
2020-02-13  6:43 ` [PATCH 2/8] perf annotate: Fix --show-total-period for tui/stdio2 Ravi Bangoria
2020-02-27 13:14   ` Arnaldo Carvalho de Melo
2020-02-29  9:16   ` [tip: perf/urgent] " tip-bot2 for Ravi Bangoria
2020-02-13  6:43 ` [PATCH 3/8] perf annotate: Fix --show-nr-samples " Ravi Bangoria
2020-02-29  9:16   ` [tip: perf/urgent] " tip-bot2 for Ravi Bangoria
2020-02-13  6:43 ` [PATCH 4/8] perf config: Introduce perf_config_u8() Ravi Bangoria
2020-02-29  9:16   ` [tip: perf/urgent] " tip-bot2 for Ravi Bangoria
2020-02-13  6:43 ` [PATCH 5/8] perf annotate: Make perf config effective Ravi Bangoria
2020-02-27 13:32   ` Arnaldo Carvalho de Melo
2020-02-29  9:16   ` [tip: perf/urgent] " tip-bot2 for Ravi Bangoria
2020-02-13  6:43 ` [PATCH 6/8] perf annotate: Prefer cmdline option over default config Ravi Bangoria
2020-02-29  9:16   ` [tip: perf/urgent] " tip-bot2 for Ravi Bangoria
2020-02-13  6:43 ` Ravi Bangoria [this message]
2020-02-29  9:16   ` [tip: perf/urgent] perf annotate: Fix perf config option description tip-bot2 for Ravi Bangoria
2020-02-13  6:43 ` [PATCH 8/8] perf config: Document missing config options Ravi Bangoria
2020-02-29  9:16   ` [tip: perf/urgent] " tip-bot2 for Ravi Bangoria
2020-02-16 21:15 ` [PATCH 0/8] perf annotate/config: More fixes Jiri Olsa
2020-02-17 13:02   ` Ravi Bangoria
2020-02-27 13:08   ` Arnaldo Carvalho de Melo
2020-02-27 13:16     ` Jiri Olsa
2020-02-27 13:43       ` Arnaldo Carvalho de Melo
2020-02-27 13:39 ` Arnaldo Carvalho de Melo

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=20200213064306.160480-8-ravi.bangoria@linux.ibm.com \
    --to=ravi.bangoria@linux.ibm.com \
    --cc=acme@kernel.org \
    --cc=adrian.hunter@intel.com \
    --cc=alexey.budankov@linux.intel.com \
    --cc=changbin.du@intel.com \
    --cc=irogers@google.com \
    --cc=jolsa@redhat.com \
    --cc=leo.yan@linaro.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=namhyung@kernel.org \
    --cc=songliubraving@fb.com \
    --cc=tmricht@linux.ibm.com \
    --cc=treeze.taeung@gmail.com \
    --cc=xieyisheng1@huawei.com \
    --cc=yao.jin@linux.intel.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).