* [PATCH] perf kmem: Improve man page for record options
@ 2021-09-22 21:20 Ian Rogers
2021-10-08 19:10 ` Arnaldo Carvalho de Melo
0 siblings, 1 reply; 2+ messages in thread
From: Ian Rogers @ 2021-09-22 21:20 UTC (permalink / raw)
To: Peter Zijlstra, Ingo Molnar, Arnaldo Carvalho de Melo,
Mark Rutland, Alexander Shishkin, Jiri Olsa, Namhyung Kim,
linux-kernel, linux-perf-users
Cc: Stephane Eranian, Ian Rogers
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>
---
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} [<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::
--
2.33.0.464.g1972c5931b-goog
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH] perf kmem: Improve man page for record options
2021-09-22 21:20 [PATCH] perf kmem: Improve man page for record options Ian Rogers
@ 2021-10-08 19:10 ` Arnaldo Carvalho de Melo
0 siblings, 0 replies; 2+ messages in thread
From: Arnaldo Carvalho de Melo @ 2021-10-08 19:10 UTC (permalink / raw)
To: Ian Rogers
Cc: Peter Zijlstra, Ingo Molnar, Mark Rutland, Alexander Shishkin,
Jiri Olsa, Namhyung Kim, linux-kernel, linux-perf-users,
Stephane Eranian
Em Wed, Sep 22, 2021 at 02:20:31PM -0700, Ian Rogers escreveu:
> 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.
Thanks, applied.
- Arnaldo
> Signed-off-by: Ian Rogers <irogers@google.com>
> ---
> 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} [<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::
> --
> 2.33.0.464.g1972c5931b-goog
--
- Arnaldo
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2021-10-08 19:10 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-09-22 21:20 [PATCH] perf kmem: Improve man page for record options Ian Rogers
2021-10-08 19:10 ` Arnaldo Carvalho de Melo
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).