Re: [PATCH 2/2] perf kvm: Update documentation with live command

[Arnaldo Carvalho de Melo <acme@ghostprotocols.net>]

Em Wed, Aug 07, 2013 at 09:56:39PM -0400, David Ahern escreveu:
> Update perf-kvm documentation with new live subcommand. Add -p/--pid option
> for perf-kvm-stat-report as well.

Minor nitpicks, that I'm fixing up, below. Applied.
 
> Signed-off-by: David Ahern <dsahern@gmail.com>
> Cc: Arnaldo Carvalho de Melo <acme@ghostprotocols.net>
> Cc: Ingo Molnar <mingo@kernel.org>
> Cc: Frederic Weisbecker <fweisbec@gmail.com>
> Cc: Peter Zijlstra <peterz@infradead.org>
> Cc: Jiri Olsa <jolsa@redhat.com>
> Cc: Namhyung Kim <namhyung@kernel.org>
> Cc: Xiao Guangrong <xiaoguangrong@linux.vnet.ibm.com>
> Cc: Runzhen Wang <runzhen@linux.vnet.ibm.com>
> ---
>  tools/perf/Documentation/perf-kvm.txt |   46 +++++++++++++++++++++++++++++++--
>  1 file changed, 44 insertions(+), 2 deletions(-)
> 
> diff --git a/tools/perf/Documentation/perf-kvm.txt b/tools/perf/Documentation/perf-kvm.txt
> index 326f2cb..ac84db2 100644
> --- a/tools/perf/Documentation/perf-kvm.txt
> +++ b/tools/perf/Documentation/perf-kvm.txt
> @@ -13,6 +13,7 @@ SYNOPSIS
>  	{top|record|report|diff|buildid-list}
>  'perf kvm' [--host] [--guest] [--guestkallsyms=<path> --guestmodules=<path>
>  	| --guestvmlinux=<path>] {top|record|report|diff|buildid-list|stat}
> +'perf kvm stat [record|report|live] [<options>]
>  
>  DESCRIPTION
>  -----------
> @@ -50,6 +51,10 @@ There are a couple of variants of perf kvm:
>    'perf kvm stat report' reports statistical data which includes events
>    handled time, samples, and so on.
>  
> +  'perf kvm stat live' reports statistical data in a live mode (similar to
> +  record + report but with statistical data updated live at a given display
> +  rate).
> +
>  OPTIONS
>  -------
>  -i::
> @@ -85,13 +90,50 @@ STAT REPORT OPTIONS
>  --vcpu=<value>::
>         analyze events which occures on this vcpu. (default: all vcpus)
>  
> ---events=<value>::
> -       events to be analyzed. Possible values: vmexit, mmio, ioport.


> +--event=<value>::
> +       event to be analyzed. Possible values: vmexit, mmio, ioport.
>         (default: vmexit)
>  -k::
>  --key=<value>::
>         Sorting key. Possible values: sample (default, sort by samples

Here you start, correctly, with a capital letter.

>         number), time (sort by average time).
> +-p::
> +--pid=::
> +    Analyze events only for given process ID(s) (comma separated list).
> +
> +STAT LIVE OPTIONS
> +-----------------
> +-d::
> +--display::
> +        Time in seconds between display updates
> +
> +-m::
> +--mmap-pages=::
> +    Number of mmap data pages. Must be a power of two.
> +
> +-a::
> +--all-cpus::
> +        System-wide collection from all CPUs.
> +
> +-p::
> +--pid=::
> +    Analyze events only for given process ID(s) (comma separated list).
> +
> +--vcpu=<value>::
> +       analyze events which occures on this vcpu. (default: all vcpus)

Here you don't.

> +
> +
> +--event=<value>::
> +       event to be analyzed. Possible values: vmexit, mmio, ioport.
> +       (default: vmexit)

Ditto

> +-k::
> +--key=<value>::
> +       Sorting key. Possible values: sample (default, sort by samples
> +       number), time (sort by average time).
> +
> +--duration=<value>::
> +       Show events other than HLT that take longer than duration usecs.
>  
>  SEE ALSO
>  --------
> -- 
> 1.7.10.1