aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJonas Rabenstein <jonas.rabenstein@studium.uni-erlangen.de>2019-02-19 10:45:15 -0500
committerArnaldo Carvalho de Melo <acme@redhat.com>2019-02-19 11:39:12 -0500
commit8c23a522388b34cd7bc8473987eda0c75eb37c0e (patch)
treebff92aba94ae75fbabc5b4df46d5498b7eac3490
parent7a663c0ff330a068c088ad46bb0130e651a9fec3 (diff)
perf doc: Fix documentation of the Flags section in perf.data
According to the current documentation the flags section is placed after the file header itself but the code assumes to find the flags section after the data section. This change updates the documentation to that assumption. Signed-off-by: Jonas Rabenstein <jonas.rabenstein@studium.uni-erlangen.de> Acked-by: Jiri Olsa <jolsa@kernel.org> Cc: Alexander Shishkin <alexander.shishkin@linux.intel.com> Cc: Andi Kleen <ak@linux.intel.com> Cc: Namhyung Kim <namhyung@kernel.org> Cc: Peter Zijlstra <peterz@infradead.org> Cc: Stephane Eranian <eranian@google.com> Cc: Thomas Richter <tmricht@linux.ibm.com> Link: http://lkml.kernel.org/r/20190219154515.3954-2-jonas.rabenstein@studium.uni-erlangen.de Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.com>
-rw-r--r--tools/perf/Documentation/perf.data-file-format.txt9
1 files changed, 4 insertions, 5 deletions
diff --git a/tools/perf/Documentation/perf.data-file-format.txt b/tools/perf/Documentation/perf.data-file-format.txt
index 5f9a3924830b..593ef49b273c 100644
--- a/tools/perf/Documentation/perf.data-file-format.txt
+++ b/tools/perf/Documentation/perf.data-file-format.txt
@@ -43,11 +43,10 @@ struct perf_file_section {
43 43
44Flags section: 44Flags section:
45 45
46The header is followed by different optional headers, described by the bits set 46For each of the optional features a perf_file_section it placed after the data
47in flags. Only headers for which the bit is set are included. Each header 47section if the feature bit is set in the perf_header flags bitset. The
48consists of a perf_file_section located after the initial header. 48respective perf_file_section points to the data of the additional header and
49The respective perf_file_section points to the data of the additional 49defines its size.
50header and defines its size.
51 50
52Some headers consist of strings, which are defined like this: 51Some headers consist of strings, which are defined like this:
53 52