From: Andi Kleen <andi@firstfloor.org>
To: acme@kernel.org
Cc: jolsa@kernel.org, eranian@google.com, mingo@kernel.org,
linux-kernel@vger.kernel.org, Andi Kleen <ak@linux.intel.com>
Subject: [PATCH 6/8] perf, tools, stat: Document CSV format in manpage
Date: Sat, 30 Jan 2016 09:06:54 -0800 [thread overview]
Message-ID: <1454173616-17710-7-git-send-email-andi@firstfloor.org> (raw)
In-Reply-To: <1454173616-17710-1-git-send-email-andi@firstfloor.org>
From: Andi Kleen <ak@linux.intel.com>
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)
Signed-off-by: Andi Kleen <ak@linux.intel.com>
---
tools/perf/Documentation/perf-stat.txt | 20 ++++++++++++++++++++
1 file changed, 20 insertions(+)
diff --git a/tools/perf/Documentation/perf-stat.txt b/tools/perf/Documentation/perf-stat.txt
index 52ef7a9..871802b 100644
--- a/tools/perf/Documentation/perf-stat.txt
+++ b/tools/perf/Documentation/perf-stat.txt
@@ -211,6 +211,26 @@ $ 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)
+ - counter value
+ - unit of the counter value or empty
+ - event name
+ - optional metric value
+ - optional unit of metric
+ - run time of counter
+ - percentage of measurement time the counter was running
+
+Additional metrics may be printed with all earlier fields being empty.
+
SEE ALSO
--------
linkperf:perf-top[1], linkperf:perf-list[1]
--
2.4.3
next prev parent reply other threads:[~2016-01-30 17:09 UTC|newest]
Thread overview: 20+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-01-30 17:06 perf, tools: Refactor and support interval and CSV metrics Andi Kleen
2016-01-30 17:06 ` [PATCH 1/8] perf, tools, stat: Abstract stat metrics printing Andi Kleen
2016-02-16 19:33 ` Arnaldo Carvalho de Melo
2016-02-17 12:09 ` [tip:perf/core] perf " tip-bot for Andi Kleen
2016-01-30 17:06 ` [PATCH 2/8] perf, tools, stat: Add support for metrics in interval mode Andi Kleen
2016-02-16 19:57 ` Arnaldo Carvalho de Melo
2016-02-17 12:09 ` [tip:perf/core] perf " tip-bot for Andi Kleen
2016-01-30 17:06 ` [PATCH 3/8] perf, tools, stat: Move noise/running printing into printout Andi Kleen
2016-02-16 20:02 ` Arnaldo Carvalho de Melo
2016-02-17 19:27 ` Andi Kleen
2016-02-17 12:10 ` [tip:perf/core] perf stat: Move noise/ running " tip-bot for Andi Kleen
2016-01-30 17:06 ` [PATCH 4/8] perf, tools, stat: Implement CSV metrics output Andi Kleen
2016-02-02 9:50 ` Jiri Olsa
2016-02-02 14:02 ` Andi Kleen
2016-01-30 17:06 ` [PATCH 5/8] perf, tools, stat: Support metrics in --per-core/socket mode Andi Kleen
2016-01-30 17:06 ` Andi Kleen [this message]
2016-01-30 17:06 ` [PATCH 7/8] perf, tools, stat: Implement --metric-only mode Andi Kleen
2016-01-30 17:06 ` [PATCH 8/8] perf, tools: Add --metric-only support for -A Andi Kleen
-- strict thread matches above, loose matches on Subject: below --
2016-01-27 0:42 perf, tools: Refactor and support interval and CSV metrics Andi Kleen
2016-01-27 0:42 ` [PATCH 6/8] perf, tools, stat: Document CSV format in manpage Andi Kleen
2016-01-16 1:11 perf, tools: Refactor and support interval and CSV metrics Andi Kleen
2016-01-16 1:11 ` [PATCH 6/8] perf, tools, stat: Document CSV format in manpage Andi Kleen
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1454173616-17710-7-git-send-email-andi@firstfloor.org \
--to=andi@firstfloor.org \
--cc=acme@kernel.org \
--cc=ak@linux.intel.com \
--cc=eranian@google.com \
--cc=jolsa@kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mingo@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).