perf top: Add --fields option to specify output fields

[cascardo/linux.git] / tools / perf / Documentation / perf-top.txt

diff --git a/tools/perf/Documentation/perf-top.txt b/tools/perf/Documentation/perf-top.txt
index 976b00c..dcfa54c 100644 (file)
--- a/tools/perf/Documentation/perf-top.txt
+++ b/tools/perf/Documentation/perf-top.txt
@@ -113,7 +113,17 @@ Default is to monitor all CPUS.
 -s::
 --sort::
        Sort by key(s): pid, comm, dso, symbol, parent, srcline, weight,
-       local_weight, abort, in_tx, transaction
+       local_weight, abort, in_tx, transaction, overhead, sample, period.
+       Please see description of --sort in the perf-report man page.
+
+--fields=::
+       Specify output field - multiple keys can be specified in CSV format.
+       Following fields are available:
+       overhead, overhead_sys, overhead_us, sample and period.
+       Also it can contain any sort key(s).
+
+       By default, every sort keys not specified in --field will be appended
+       automatically.
 
 -n::
 --show-nr-samples::
@@ -123,13 +133,16 @@ Default is to monitor all CPUS.
        Show a column with the sum of periods.
 
 --dsos::
-       Only consider symbols in these dsos.
+       Only consider symbols in these dsos.  This option will affect the
+       percentage of the overhead column.  See --percentage for more info.
 
 --comms::
-       Only consider symbols in these comms.
+       Only consider symbols in these comms.  This option will affect the
+       percentage of the overhead column.  See --percentage for more info.
 
 --symbols::
-       Only consider these symbols.
+       Only consider these symbols.  This option will affect the
+       percentage of the overhead column.  See --percentage for more info.
 
 -M::
 --disassembler-style=:: Set disassembler style for objdump.
@@ -165,6 +178,15 @@ Default is to monitor all CPUS.
        Do not show entries which have an overhead under that percent.
        (Default: 0).
 
+--percentage::
+       Determine how to display the overhead percentage of filtered entries.
+       Filters can be applied by --comms, --dsos and/or --symbols options and
+       Zoom operations on the TUI (thread, dso, etc).
+
+       "relative" means it's relative to filtered entries only so that the
+       sum of shown entries will be always 100%. "absolute" means it retains
+       the original value before and after the filter is applied.
+
 INTERACTIVE PROMPTING KEYS
 --------------------------
 
@@ -200,4 +222,4 @@ Pressing any unmapped key displays a menu, and prompts for input.
 
 SEE ALSO
 --------
-linkperf:perf-stat[1], linkperf:perf-list[1]
+linkperf:perf-stat[1], linkperf:perf-list[1], linkperf:perf-report[1]