perf kmem: Improve man page for record options
Ian Rogers
reviewerPATCH 1/1 perf kmem: Improve man page for record options
Since:
https://lore.kernel.org/lkml/[email protected]/
The output option works for 'perf kmem', however, it must appear after 'record'. This is different to 'stat' where '-i' for the input must appear before. Try to capture this complication in the man page.
Signed-off-by Ian Rogers <[email protected]>
--- tools/perf/Documentation/perf-kmem.txt | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-)
tools/perf/Documentation/perf-kmem.txt +8 -5
@@ -8,22 +8,25 @@ perf-kmem - Tool to trace/measure kernel memory properties SYNOPSIS -------- [verse] -'perf kmem' {record|stat} [<options>] +'perf kmem' [<options>] {record|stat} DESCRIPTION ----------- There are two variants of perf kmem: - 'perf kmem record <command>' to record the kmem events - of an arbitrary workload. + 'perf kmem [<options>] record [<perf-record-options>] <command>' to + record the kmem events of an arbitrary workload. Additional 'perf + record' options may be specified after record, such as '-o' to + change the output file name. - 'perf kmem stat' to report kernel memory statistics. + 'perf kmem [<options>] stat' to report kernel memory statistics. OPTIONS ------- -i <file>:: --input=<file>:: - Select the input file (default: perf.data unless stdin is a fifo) + For stat, select the input file (default: perf.data unless stdin is a + fifo) -f:: --force::
Signature · 1 line
2.33.0.464.g1972c5931b-goog
Em Wed, Sep 22, 2021 at 02:20:31PM -0700, Ian Rogers escreveu:
Quoted 5 lines
Since:
https://lore.kernel.org/lkml/[email protected]/
The output option works for 'perf kmem', however, it must appear after 'record'. This is different to 'stat' where '-i' for the input must appear before. Try to capture this complication in the man page.
Thanks, applied.
- Arnaldo
Quoted 42 lines
Signed-off-by Ian Rogers <[email protected]>--- tools/perf/Documentation/perf-kmem.txt | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-)tools/perf/Documentation/perf-kmem.txt +8
-5@@ -8,22 +8,25 @@ perf-kmem - Tool to trace/measure kernel memory properties SYNOPSIS -------- [verse] -'perf kmem' {record|stat} [<options>] +'perf kmem' [<options>] {record|stat} DESCRIPTION ----------- There are two variants of perf kmem: - 'perf kmem record <command>' to record the kmem events - of an arbitrary workload. + 'perf kmem [<options>] record [<perf-record-options>] <command>' to + record the kmem events of an arbitrary workload. Additional 'perf + record' options may be specified after record, such as '-o' to + change the output file name. - 'perf kmem stat' to report kernel memory statistics. + 'perf kmem [<options>] stat' to report kernel memory statistics. OPTIONS ------- -i <file>:: --input=<file>:: - Select the input file (default: perf.data unless stdin is a fifo) + For stat, select the input file (default: perf.data unless stdin is a + fifo) -f:: --force::Signature · 1 line
2.33.0.464.g1972c5931b-goog
Signature · 1 line
- Arnaldo