diff mbox series

trace-cmd: Update v7 trace.dat documentation to clarify the strings section

Message ID 20230602033726.3c0ac34a@rorschach.local.home (mailing list archive)
State Accepted
Commit 6776d7af303beaf2c39c67d2443c88987900c387
Headers show
Series trace-cmd: Update v7 trace.dat documentation to clarify the strings section | expand

Commit Message

Steven Rostedt June 2, 2023, 7:37 a.m. UTC 
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 mbox series

Patch

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.