From f792cf8a094eac29e1d4e3d588dffbe68c7741a6 Mon Sep 17 00:00:00 2001 From: Ian Rogers Date: Wed, 22 Sep 2021 14:20:31 -0700 Subject: [PATCH] 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 Cc: Alexander Shishkin Cc: Jiri Olsa Cc: Mark Rutland Cc: Namhyung Kim Cc: Peter Zijlstra Cc: Stephane Eranian Link: http://lore.kernel.org/lkml/20210922212031.485950-1-irogers@google.com Signed-off-by: Arnaldo Carvalho de Melo --- tools/perf/Documentation/perf-kmem.txt | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/tools/perf/Documentation/perf-kmem.txt b/tools/perf/Documentation/perf-kmem.txt index 85b8ac695c87..f378ac59353d 100644 --- a/tools/perf/Documentation/perf-kmem.txt +++ b/tools/perf/Documentation/perf-kmem.txt @@ -8,22 +8,25 @@ perf-kmem - Tool to trace/measure kernel memory properties SYNOPSIS -------- [verse] -'perf kmem' {record|stat} [] +'perf kmem' [] {record|stat} DESCRIPTION ----------- There are two variants of perf kmem: - 'perf kmem record ' to record the kmem events - of an arbitrary workload. + 'perf kmem [] record [] ' 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 [] stat' to report kernel memory statistics. OPTIONS ------- -i :: --input=:: - 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:: -- 2.11.0