perf kvm: Clarify the 'perf kvm' -i and -o command line options
authorArnaldo Carvalho de Melo <acme@redhat.com>
Mon, 2 Dec 2019 18:38:59 +0000 (15:38 -0300)
committerArnaldo Carvalho de Melo <acme@redhat.com>
Mon, 2 Dec 2019 18:38:59 +0000 (15:38 -0300)
commit9974406884459c9301597c2c9f7def6c38099ab4
treea9e3ab467da636e775ad7ce4d5ff1f5c0688afc1
parenta717ab38a51404a3f7069987f77676cde82139ac
perf kvm: Clarify the 'perf kvm' -i and -o command line options

The 'perf kvm' subcommand has options that it in turn passes to other
perf subcommands such as 'report' and 'record', particularly -i and -o
end up setting the same variable that will then be used for 'record's -o
and report '-i', which ends up being confusing, leading some to think
that both -i and -o can be used with 'report'.

Improve the man page to state that -i is used with the post-processing
subcommands while -o is used just with 'record' and that to save the
output of 'report' one should simply redirect its output to a file.

Noticed while reading the https://www.linux-kvm.org/page/Perf_events
page.

Cc: Adrian Hunter <adrian.hunter@intel.com>
Cc: Jiri Olsa <jolsa@kernel.org>
Cc: Namhyung Kim <namhyung@kernel.org>
Cc: Steve Dickson <steved@redhat.com>
Cc: William Cohen <wcohen@redhat.com>
Link: https://lkml.kernel.org/n/tip-tclbttvmgtm525fvmh85f7d9@git.kernel.org
Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.com>
tools/perf/Documentation/perf-kvm.txt