From 5b74bd2aeee46081b68b0ba5bd5f8353737c86aa Mon Sep 17 00:00:00 2001 From: Josef Weidendorfer Date: Fri, 26 Jun 2015 15:44:01 +0000 Subject: [PATCH] Minor shuffling in Callgrind format doc git-svn-id: svn://svn.valgrind.org/valgrind/trunk@15360 --- callgrind/docs/cl-format.xml | 27 +++++++++++++++------------ 1 file changed, 15 insertions(+), 12 deletions(-) diff --git a/callgrind/docs/cl-format.xml b/callgrind/docs/cl-format.xml index 00b0a52be9..182b199b59 100644 --- a/callgrind/docs/cl-format.xml +++ b/callgrind/docs/cl-format.xml @@ -378,18 +378,21 @@ for "Ir and "Dr". NoNewLineChar := all characters without "\n" +A profile data file ("ProfileDataFile") starts with basic information + such as the version and creator information, and then has a list of parts, where + each part has its own header and body. Parts typically are different threads + and/or time spans/phases within a profiled application run. + +Note that callgrind_annotate currently only supports profile data files with + one part. Callgrind may produce multiple parts for one profile run, but defaults + to one output file for each part. + Description of Header Lines -As given in the grammar, a profile data file starts with basic information - such as the version and creator information, and then has a list of parts, where - each part has its own header and body. Parts typically are different threads - and/or time spans/phases within a profiled application run. - -Basic information in the first lines of a profile data file, - optionally, allowed to appear only once: +Basic information in the first lines of a profile data file: @@ -465,11 +468,11 @@ for "Ir and "Dr". events: event type abbreviations [Cachegrind] - A list of short names of the event types logged in this - file. Arbitrary short names are allowed. The order given - specifies the required order in cost lines within the body of - this part. Thus, the first event type is the second or third number - in a cost line, depending on the value of "positions". + A list of short names of the event types logged in cost + lines in this part of the profile data file. Arbitrary short + names are allowed. The order given specifies the required order + in cost lines. Thus, the first event type is the second or third + number in a cost line, depending on the value of "positions". Required to appear for each header part exactly once. -- 2.47.3