From: Steven Rostedt <rostedt@goodmis.org>
To: Linux Trace Devel <linux-trace-devel@vger.kernel.org>
Cc: Douglas RAILLARD <douglas.raillard@arm.com>,
Tzvetomir Stoyanov <tz.stoyanov@gmail.com>
Subject: [PATCH] trace-cmd: Update v7 trace.dat documentation to clarify the strings section
Date: Fri, 2 Jun 2023 03:37:26 -0400 [thread overview]
Message-ID: <20230602033726.3c0ac34a@rorschach.local.home> (raw)
From: "Steven Rostedt (Google)" <rostedt@goodmis.org>
The string section description in the trace.dat v7 man page is a little
confusing. It is missing its section id, and so is the buffer text
section. Add the ids and clear up the description slightly.
Bugzilla: https://bugzilla.kernel.org/show_bug.cgi?id=217351
Reported-by: Douglas RAILLARD <douglas.raillard@arm.com>
Signed-off-by: Steven Rostedt (Google) <rostedt@goodmis.org>
---
Documentation/trace-cmd/trace-cmd.dat.v7.5.txt | 12 ++++++++++--
1 file changed, 10 insertions(+), 2 deletions(-)
diff --git a/Documentation/trace-cmd/trace-cmd.dat.v7.5.txt b/Documentation/trace-cmd/trace-cmd.dat.v7.5.txt
index b19d2842a745..2f7e6a4a4654 100644
--- a/Documentation/trace-cmd/trace-cmd.dat.v7.5.txt
+++ b/Documentation/trace-cmd/trace-cmd.dat.v7.5.txt
@@ -226,6 +226,10 @@ OPTIONS SECTION
<4 bytes> unsigned integer, time shift.
<8 bytes> unsigned long long integer, time offset.
+ STRINGS: id 15, size vary
+ The STRINGS option holds a list of nul terminated strings that holds the names of the
+ other sections.
+
HEADER_INFO: id 16, size 8
The HEADER_INFO option data is:
<8 bytes> long long unsigned integer, offset into the trace file where the HEADER INFO
@@ -419,14 +423,18 @@ BUFFER FLYRECORD SECTION
BUFFER TEXT SECTION
------------------------
+ Section ID: 22
+
This section contains latency tracing data, ASCII text taken from the
target's debugfs/tracing/trace file.
STRINGS SECTION
------------------------
- All strings from trace file metadata are stored in string section in the file. The section
- contains a list of NULL terminated ASCII strings. An ID of the string is used in the file
+ Section ID: 15
+
+ All strings of the trace file metadata are stored in a string section within the file. The section
+ contains a list of nul terminated ASCII strings. An ID of the string is used in the file
meta data, which is the offset of the actual string into the string section. Strings can be stored
into multiple string sections in the file.
--
2.39.2
reply other threads:[~2023-06-02 7:37 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
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=20230602033726.3c0ac34a@rorschach.local.home \
--to=rostedt@goodmis.org \
--cc=douglas.raillard@arm.com \
--cc=linux-trace-devel@vger.kernel.org \
--cc=tz.stoyanov@gmail.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).