From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S932920AbcA3RJj (ORCPT ); Sat, 30 Jan 2016 12:09:39 -0500 Received: from mga01.intel.com ([192.55.52.88]:32287 "EHLO mga01.intel.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1757084AbcA3RHI (ORCPT ); Sat, 30 Jan 2016 12:07:08 -0500 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.22,371,1449561600"; d="scan'208";a="872686170" From: Andi Kleen To: acme@kernel.org Cc: jolsa@kernel.org, eranian@google.com, mingo@kernel.org, linux-kernel@vger.kernel.org, Andi Kleen Subject: [PATCH 6/8] perf, tools, stat: Document CSV format in manpage Date: Sat, 30 Jan 2016 09:06:54 -0800 Message-Id: <1454173616-17710-7-git-send-email-andi@firstfloor.org> X-Mailer: git-send-email 2.4.3 In-Reply-To: <1454173616-17710-1-git-send-email-andi@firstfloor.org> References: <1454173616-17710-1-git-send-email-andi@firstfloor.org> Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org From: Andi Kleen 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 --- 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