linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Andi Kleen <andi@firstfloor.org>
To: acme@kernel.org
Cc: jolsa@kernel.org, mingo@kernel.org, linux-kernel@vger.kernel.org,
	eranian@google.com, Andi Kleen <ak@linux.intel.com>
Subject: [PATCH 6/9] perf, tools, stat: Document CSV format in manpage
Date: Tue, 19 Jan 2016 18:26:49 -0800	[thread overview]
Message-ID: <1453256812-24006-7-git-send-email-andi@firstfloor.org> (raw)
In-Reply-To: <1453256812-24006-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.

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 52ef7a9..6629a8e 100644
--- a/tools/perf/Documentation/perf-stat.txt
+++ b/tools/perf/Documentation/perf-stat.txt
@@ -211,6 +211,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

  parent reply	other threads:[~2016-01-20  2:27 UTC|newest]

Thread overview: 24+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-01-20  2:26 perf, tools: Refactor and support interval and CSV metrics Andi Kleen
2016-01-20  2:26 ` [PATCH 1/9] perf, tools, stat: Abstract stat metrics printing Andi Kleen
2016-01-22  9:41   ` Jiri Olsa
2016-01-22 10:05   ` Jiri Olsa
2016-01-20  2:26 ` [PATCH 2/9] perf, tools, stat: Add support for metrics in interval mode Andi Kleen
2016-01-22  9:41   ` Jiri Olsa
2016-01-20  2:26 ` [PATCH 3/9] perf, tools, stat: Move noise/running printing into printout Andi Kleen
2016-01-22  9:41   ` Jiri Olsa
2016-01-23  3:43     ` Andi Kleen
2016-01-23 16:19       ` Jiri Olsa
2016-01-26 23:57         ` Andi Kleen
2016-01-28  9:48           ` Jiri Olsa
2016-01-26 23:56     ` Andi Kleen
2016-01-20  2:26 ` [PATCH 4/9] perf, tools, stat: Implement CSV metrics output Andi Kleen
2016-01-22  9:57   ` Jiri Olsa
2016-01-20  2:26 ` [PATCH 5/9] perf, tools: Support metrics in --per-core/socket mode Andi Kleen
2016-01-20  2:26 ` Andi Kleen [this message]
2016-01-22 10:03   ` [PATCH 6/9] perf, tools, stat: Document CSV format in manpage Jiri Olsa
2016-01-22 10:08   ` Jiri Olsa
2016-01-23  3:43     ` Andi Kleen
2016-01-20  2:26 ` [PATCH 7/9] perf, tools, stat: Implement --metric-only mode Andi Kleen
2016-01-20  2:26 ` [PATCH 8/9] perf, tools: Add --metric-only support for -A Andi Kleen
2016-01-20  2:26 ` [PATCH 9/9] perf, tools, stat: Fix indentation of counter running printout Andi Kleen
2016-01-22 10:10 ` perf, tools: Refactor and support interval and CSV metrics Jiri Olsa

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=1453256812-24006-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).