Skip to content

Commit cd0a9c5

Browse files
Ravi Bangoriaacmel
authored andcommitted
perf annotate: Fix perf config option description
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 <[email protected]> Cc: Adrian Hunter <[email protected]> Cc: Alexey Budankov <[email protected]> Cc: Changbin Du <[email protected]> Cc: Ian Rogers <[email protected]> Cc: Jin Yao <[email protected]> Cc: Jiri Olsa <[email protected]> Cc: Leo Yan <[email protected]> Cc: Namhyung Kim <[email protected]> Cc: Song Liu <[email protected]> Cc: Taeung Song <[email protected]> Cc: Thomas Richter <[email protected]> Cc: Yisheng Xie <[email protected]> Link: http://lore.kernel.org/lkml/[email protected] Signed-off-by: Arnaldo Carvalho de Melo <[email protected]>
1 parent 812b0f5 commit cd0a9c5

File tree

1 file changed

+29
-1
lines changed

1 file changed

+29
-1
lines changed

tools/perf/Documentation/perf-config.txt

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,6 @@ buildid.*::
239239
set buildid.dir to /dev/null. The default is $HOME/.debug
240240

241241
annotate.*::
242-
These options work only for TUI.
243242
These are in control of addresses, jump function, source code
244243
in lines of assembly code from a specific program.
245244

@@ -269,6 +268,8 @@ annotate.*::
269268
│ mov (%rdi),%rdx
270269
│ return n;
271270

271+
This option works with tui, stdio2 browsers.
272+
272273
annotate.use_offset::
273274
Basing on a first address of a loaded function, offset can be used.
274275
Instead of using original addresses of assembly code,
@@ -287,6 +288,8 @@ annotate.*::
287288

288289
368:│ mov 0x8(%r14),%rdi
289290

291+
This option works with tui, stdio2 browsers.
292+
290293
annotate.jump_arrows::
291294
There can be jump instruction among assembly code.
292295
Depending on a boolean value of jump_arrows,
@@ -306,6 +309,8 @@ annotate.*::
306309
│1330: mov %r15,%r10
307310
│1333: cmp %r15,%r14
308311

312+
This option works with tui browser.
313+
309314
annotate.show_linenr::
310315
When showing source code if this option is 'true',
311316
line numbers are printed as below.
@@ -325,6 +330,8 @@ annotate.*::
325330
│ array++;
326331
│ }
327332

333+
This option works with tui, stdio2 browsers.
334+
328335
annotate.show_nr_jumps::
329336
Let's see a part of assembly code.
330337

@@ -335,6 +342,8 @@ annotate.*::
335342

336343
│1 1382: movb $0x1,-0x270(%rbp)
337344

345+
This option works with tui, stdio2 browsers.
346+
338347
annotate.show_total_period::
339348
To compare two records on an instruction base, with this option
340349
provided, display total number of samples that belong to a line
@@ -348,11 +357,30 @@ annotate.*::
348357

349358
99.93 │ mov %eax,%eax
350359

360+
This option works with tui, stdio2, stdio browsers.
361+
362+
annotate.show_nr_samples::
363+
By default perf annotate shows percentage of samples. This option
364+
can be used to print absolute number of samples. Ex, when set as
365+
false:
366+
367+
Percent│
368+
74.03 │ mov %fs:0x28,%rax
369+
370+
When set as true:
371+
372+
Samples│
373+
6 │ mov %fs:0x28,%rax
374+
375+
This option works with tui, stdio2, stdio browsers.
376+
351377
annotate.offset_level::
352378
Default is '1', meaning just jump targets will have offsets show right beside
353379
the instruction. When set to '2' 'call' instructions will also have its offsets
354380
shown, 3 or higher will show offsets for all instructions.
355381

382+
This option works with tui, stdio2 browsers.
383+
356384
hist.*::
357385
hist.percentage::
358386
This option control the way to calculate overhead of filtered entries -

0 commit comments

Comments
 (0)