[PATCH 9/9] perf, tools, stat: Document CSV format in manpage

Andi Kleen
2015-09-02T23:37:53Z

With all the recently added fields in the perf stat CSV output
we should finally document them in the man page. Do this here.

Signed-off-by: Andi Kleen <ak@linux.intel.com>
---
tools/perf/Documentation/perf-stat.txt | 19 +++++++++++++++++++
1 file changed, 19 insertions(+)

diff --git a/tools/perf/Documentation/perf-stat.txt b/tools/perf/Documentation/perf-stat.txt
index 47469ab..0541714 100644
--- a/tools/perf/Documentation/perf-stat.txt
+++ b/tools/perf/Documentation/perf-stat.txt
@@ -176,6 +176,25 @@ $ 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 "")
+
+The fields are in this order:
+
+ - optional usec time stamp in fractions of second (with -I xxx)
+ - unit of the counter value or empty
+ - event name
+ - counter value
+ - run time of counter
+ - percentage of measurement time the counter was running
+ - 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.4.3