Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

perf kmem: Improve man page for record options

Since:

https://lore.kernel.org/lkml/20200708183919.4141023-1-irogers@google.com/

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 <irogers@google.com>
Cc: Alexander Shishkin <alexander.shishkin@linux.intel.com>
Cc: Jiri Olsa <jolsa@redhat.com>
Cc: Mark Rutland <mark.rutland@arm.com>
Cc: Namhyung Kim <namhyung@kernel.org>
Cc: Peter Zijlstra <peterz@infradead.org>
Cc: Stephane Eranian <eranian@google.com>
Link: http://lore.kernel.org/lkml/20210922212031.485950-1-irogers@google.com
Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.com>

authored by

Ian Rogers and committed by
Arnaldo Carvalho de Melo
f792cf8a eda1a84c

+8 -5
+8 -5
tools/perf/Documentation/perf-kmem.txt
··· 8 8 SYNOPSIS 9 9 -------- 10 10 [verse] 11 - 'perf kmem' {record|stat} [<options>] 11 + 'perf kmem' [<options>] {record|stat} 12 12 13 13 DESCRIPTION 14 14 ----------- 15 15 There are two variants of perf kmem: 16 16 17 - 'perf kmem record <command>' to record the kmem events 18 - of an arbitrary workload. 17 + 'perf kmem [<options>] record [<perf-record-options>] <command>' to 18 + record the kmem events of an arbitrary workload. Additional 'perf 19 + record' options may be specified after record, such as '-o' to 20 + change the output file name. 19 21 20 - 'perf kmem stat' to report kernel memory statistics. 22 + 'perf kmem [<options>] stat' to report kernel memory statistics. 21 23 22 24 OPTIONS 23 25 ------- 24 26 -i <file>:: 25 27 --input=<file>:: 26 - Select the input file (default: perf.data unless stdin is a fifo) 28 + For stat, select the input file (default: perf.data unless stdin is a 29 + fifo) 27 30 28 31 -f:: 29 32 --force::