Re: [PATCH 4/7] perf, tools, stat: Document CSV format in manpage

From: Jiri Olsa
Date: Thu Mar 10 2016 - 06:29:23 EST


On Thu, Mar 03, 2016 at 03:57:35PM -0800, Andi Kleen wrote:
> From: Andi Kleen <ak@xxxxxxxxxxxxxxx>
>
> With all the recently added fields in the perf stat CSV output
> we should finally document them in the man page. Do this here.
>
> v2: Fix fields in documentation (Jiri)
> v3: fix order of fields again (Jiri)
> v4: Change order again.
> v5: Document more fields (Jiri)
> v6: Move time stamp first
> v7: More fixes (Jiri)

Acked-by: Jiri Olsa <jolsa@xxxxxxxxxx>

thanks,
jirka

> Signed-off-by: Andi Kleen <ak@xxxxxxxxxxxxxxx>
> ---
> tools/perf/Documentation/perf-stat.txt | 23 +++++++++++++++++++++++
> 1 file changed, 23 insertions(+)
>
> diff --git a/tools/perf/Documentation/perf-stat.txt b/tools/perf/Documentation/perf-stat.txt
> index 52ef7a9..e513a1c 100644
> --- a/tools/perf/Documentation/perf-stat.txt
> +++ b/tools/perf/Documentation/perf-stat.txt
> @@ -211,6 +211,29 @@ $ perf stat -- make -j
>
> Wall-clock time elapsed: 719.554352 msecs
>
> +CSV FORMAT
> +----------
> +
> +With -x, perf stat is able to output a not-quite-CSV format output
> +Commas in the output are not put into "". To make it easy to parse
> +it is recommended to use a different character like -x \;
> +
> +The fields are in this order:
> +
> + - optional usec time stamp in fractions of second (with -I xxx)
> + - optional CPU, core, or socket identifier
> + - optional number of logical CPUs aggregated
> + - counter value
> + - unit of the counter value or empty
> + - event name
> + - run time of counter
> + - percentage of measurement time the counter was running
> + - optional variance if multiple values are collected with -r
> + - optional metric value
> + - optional unit of metric
> +
> +Additional metrics may be printed with all earlier fields being empty.
> +
> SEE ALSO
> --------
> linkperf:perf-top[1], linkperf:perf-list[1]
> --
> 2.5.0
>