perf mem: Document uncorrect and missing options
PATCH 1/1 perf mem: Document uncorrect and missing options
Signed-off-by Sangwon Hong <[email protected]>
--- tools/perf/Documentation/perf-mem.txt | 41 +++++++++++++++++++++++++---------- 1 file changed, 29 insertions(+), 12 deletions(-)
tools/perf/Documentation/perf-mem.txt +29 -12
@@ -28,29 +28,46 @@ OPTIONS <command>...:: Any command you can specify in a shell. +-i:: +--input=<file>:: + Input file name. + -f:: --force:: Don't do ownership validation -t:: ---type=:: +--type=<type>:: Select the memory operation type: load or store (default: load,store) -D:: ---dump-raw-samples=:: +--dump-raw-samples:: Dump the raw decoded samples on the screen in a format that is easy to parse with one sample per line. -x:: ---field-separator:: +--field-separator=<separator>:: Specify the field separator used when dump raw samples (-D option). By default, The separator is the space character. -C:: ---cpu-list:: - 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. +--cpu=<cpu>:: + 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. +-U:: +--hide-unresolved:: + Only display entries resolved to a symbol. + +-p:: +--phys-data:: + Record/Report sample physical addresses + +RECORD OPTIONS +-------------- +-e:: +--event <event>:: + Event selector. Use 'perf mem record -e list' to list available events. -K:: --all-kernel::
@@ -60,12 +77,12 @@ OPTIONS --all-user:: Configure all used events to run in user space. ---ldload:: - Specify desired latency for loads event. +-v:: +--verbose:: + Be more verbose (show counter open errors, etc) --p:: ---phys-data:: - Record/Report sample physical addresses +--ldlat <n>:: + Specify desired latency for loads event. SEE ALSO --------
Signature · 1 line
2.7.4
On Sun, Apr 22, 2018 at 04:29:06PM +0900, Sangwon Hong wrote:
SNIP
Quoted 12 lines
-C::
---cpu-list::tools/perf/Documentation/perf-mem.txt +7
-3- 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. +--cpu=<cpu>:: + 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. +-U:: +--hide-unresolved:: + Only display entries resolved to a symbol.
tools/perf/Documentation/perf-mem.txt OPTIONS · line 70
Quoted 10 lines
tools/perf/Documentation/perf-mem.txt +10
-0+ +-p:: +--phys-data:: + Record/Report sample physical addresses + +RECORD OPTIONS +-------------- +-e:: +--event <event>:: + Event selector. Use 'perf mem record -e list' to list available events.
extra white space at the end of above line.. other than that it looks ok, thanks for doing this
Acked-by Jiri Olsa <[email protected]>
thanks,
jirka
tip-bot for Sangwon Hong
merge bot[tip:perf/urgent] perf mem: Document incorrect and missing options
In reply to Sangwon Hongperf mem: Document incorrect and missing options
Commit-ID: 3138a2ef62667b6ac8eb5fb33a9e0b84ec3ab165 Gitweb: https://git.kernel.org/tip/3138a2ef62667b6ac8eb5fb33a9e0b84ec3ab165 Author: Sangwon Hong <[email protected]> AuthorDate: Sun, 22 Apr 2018 16:29:06 +0900 Committer: Arnaldo Carvalho de Melo <[email protected]> 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 <[email protected]>
Acked-by Jiri Olsa <[email protected]>
Cc Namhyung Kim <[email protected]>
Cc Taeung Song <[email protected]>
Signed-off-by Arnaldo Carvalho de Melo <[email protected]>
--- tools/perf/Documentation/perf-mem.txt | 41 +++++++++++++++++++++++++---------- 1 file changed, 29 insertions(+), 12 deletions(-)
tools/perf/Documentation/perf-mem.txt +29 -12
@@ -28,29 +28,46 @@ OPTIONS <command>...:: Any command you can specify in a shell. +-i:: +--input=<file>:: + Input file name. + -f:: --force:: Don't do ownership validation -t:: ---type=:: +--type=<type>:: Select the memory operation type: load or store (default: load,store) -D:: ---dump-raw-samples=:: +--dump-raw-samples:: Dump the raw decoded samples on the screen in a format that is easy to parse with one sample per line. -x:: ---field-separator:: +--field-separator=<separator>:: Specify the field separator used when dump raw samples (-D option). By default, The separator is the space character. -C:: ---cpu-list:: - 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. +--cpu=<cpu>:: + 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. +-U:: +--hide-unresolved:: + Only display entries resolved to a symbol. + +-p:: +--phys-data:: + Record/Report sample physical addresses + +RECORD OPTIONS +-------------- +-e:: +--event <event>:: + Event selector. Use 'perf mem record -e list' to list available events. -K:: --all-kernel::
@@ -60,12 +77,12 @@ OPTIONS --all-user:: Configure all used events to run in user space. ---ldload:: - Specify desired latency for loads event. +-v:: +--verbose:: + Be more verbose (show counter open errors, etc) --p:: ---phys-data:: - 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.