linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jonas Rabenstein <jonas.rabenstein@studium.uni-erlangen.de>
To: linux-perf-users@vger.kernel.org
Cc: Peter Zijlstra <peterz@infradead.org>,
	Ingo Molnar <mingo@redhat.com>,
	Arnaldo Carvalho de Melo <acme@kernel.org>,
	Alexander Shishkin <alexander.shishkin@linux.intel.com>,
	Jiri Olsa <jolsa@redhat.com>, Namhyung Kim <namhyung@kernel.org>,
	Andi Kleen <ak@linux.intel.com>,
	Thomas Richter <tmricht@linux.ibm.com>,
	Stephane Eranian <eranian@google.com>,
	Jonas Rabenstein <jonas.rabenstein@studium.uni-erlangen.de>,
	linux-kernel@vger.kernel.org
Subject: [PATCH] perf: fix documentation of the Flags section in perf.data
Date: Mon, 18 Feb 2019 15:18:46 +0100	[thread overview]
Message-ID: <20190218141846.2995-1-jonas.rabenstein@studium.uni-erlangen.de> (raw)
In-Reply-To: <20190217232246.GB26460@krava>

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.
---
 tools/perf/Documentation/perf.data-file-format.txt | 9 ++++-----
 1 file 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 {
 
 Flags section:
 
-The header is followed by different optional headers, described by the bits set
-in flags. Only headers for which the bit is set are included. Each header
-consists of a perf_file_section located after the initial header.
-The respective perf_file_section points to the data of the additional
-header and defines its size.
+For each of the optional features a perf_file_section it placed after the data
+section if the feature bit is set in the perf_header flags bitset. The
+respective perf_file_section points to the data of the additional header and
+defines its size.
 
 Some headers consist of strings, which are defined like this:
 
-- 
2.19.2


  parent reply	other threads:[~2019-02-18 14:19 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-02-15 18:28 [PATCH] perf: update perf.data file format documentation Jonas Rabenstein
2019-02-17 23:22 ` Jiri Olsa
2019-02-18  9:04   ` Jonas Rabenstein
2019-02-18 12:46   ` Arnaldo Carvalho de Melo
2019-02-18 14:02     ` [PATCH] perf: fix HEADER_CMDLINE description in perf.data documentation Jonas Rabenstein
2019-02-19 14:04       ` Jiri Olsa
2019-02-19 15:24         ` Arnaldo Carvalho de Melo
2019-02-19 15:45           ` Jonas Rabenstein
2019-02-19 15:45             ` [PATCH] perf: fix documentation of the Flags section in perf.data Jonas Rabenstein
2019-02-28  7:41               ` [tip:perf/core] perf doc: Fix " tip-bot for Jonas Rabenstein
2019-02-28  7:41             ` [tip:perf/core] perf doc: Fix HEADER_CMDLINE description in perf.data documentation tip-bot for Jonas Rabenstein
2019-02-18 14:18   ` Jonas Rabenstein [this message]
2019-02-19 14:04     ` [PATCH] perf: fix documentation of the Flags section in perf.data 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=20190218141846.2995-1-jonas.rabenstein@studium.uni-erlangen.de \
    --to=jonas.rabenstein@studium.uni-erlangen.de \
    --cc=acme@kernel.org \
    --cc=ak@linux.intel.com \
    --cc=alexander.shishkin@linux.intel.com \
    --cc=eranian@google.com \
    --cc=jolsa@redhat.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-perf-users@vger.kernel.org \
    --cc=mingo@redhat.com \
    --cc=namhyung@kernel.org \
    --cc=peterz@infradead.org \
    --cc=tmricht@linux.ibm.com \
    /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).