[tip:perf/urgent] perf mem: Document incorrect and missing options

From: tip-bot for Sangwon Hong
Date: Thu Apr 26 2018 - 01:55:28 EST

Commit-ID: 3138a2ef62667b6ac8eb5fb33a9e0b84ec3ab165
Gitweb: https://git.kernel.org/tip/3138a2ef62667b6ac8eb5fb33a9e0b84ec3ab165
Author: Sangwon Hong <qpakzk@xxxxxxxxx>
AuthorDate: Sun, 22 Apr 2018 16:29:06 +0900
Committer: Arnaldo Carvalho de Melo <acme@xxxxxxxxxx>
CommitDate: Mon, 23 Apr 2018 11:59:18 -0300

perf mem: Document incorrect and missing options

Several options were incorrectly described, some lacked describing
required arguments while others were simply not documented, fix it.

Signed-off-by: Sangwon Hong <qpakzk@xxxxxxxxx>
Acked-by: Jiri Olsa <jolsa@xxxxxxxxxx>
Cc: Namhyung Kim <namhyung@xxxxxxxxxx>
Cc: Taeung Song <treeze.taeung@xxxxxxxxx>
Link: http://lkml.kernel.org/r/1524382146-19609-1-git-send-email-qpakzk@xxxxxxxxx
Signed-off-by: Arnaldo Carvalho de Melo <acme@xxxxxxxxxx>
tools/perf/Documentation/perf-mem.txt | 41 +++++++++++++++++++++++++----------
1 file changed, 29 insertions(+), 12 deletions(-)

diff --git a/tools/perf/Documentation/perf-mem.txt b/tools/perf/Documentation/perf-mem.txt
index 8806ed5f3802..f8d2167cf3e7 100644
--- a/tools/perf/Documentation/perf-mem.txt
+++ b/tools/perf/Documentation/perf-mem.txt
@@ -28,29 +28,46 @@ OPTIONS
Any command you can specify in a shell.

+ Input file name.
Don't do ownership validation

Select the memory operation type: load or store (default: load,store)

Dump the raw decoded samples on the screen in a format that is easy to parse with
one sample per line.

Specify the field separator used when dump raw samples (-D option). By default,
The separator is the space character.

- Restrict dump of raw samples to those provided via this option. Note that the same
- option can be passed in record mode. It will be interpreted the same way as perf
- record.
+ Monitor only on the list of CPUs provided. Multiple CPUs can be provided as a
+ comma-separated list with no space: 0,1. Ranges of CPUs are specified with -: 0-2. Default
+ is to monitor all CPUS.
+ Only display entries resolved to a symbol.
+ Record/Report sample physical addresses
+--event <event>::
+ Event selector. Use 'perf mem record -e list' to list available events.

@@ -60,12 +77,12 @@ OPTIONS
Configure all used events to run in user space.

- Specify desired latency for loads event.
+ Be more verbose (show counter open errors, etc)

- Record/Report sample physical addresses
+--ldlat <n>::
+ Specify desired latency for loads event.

In addition, for report all perf report options are valid, and for record
all perf record options.