From: Purva Yeshi <purvayeshi550@gmail.com>
To: rostedt@goodmis.org, mhiramat@kernel.org, corbet@lwn.net
Cc: skhan@linuxfoundation.org, mathieu.desnoyers@efficios.com,
linux-kernel@vger.kernel.org, linux-trace-kernel@vger.kernel.org,
linux-doc@vger.kernel.org, Purva Yeshi <purvayeshi550@gmail.com>
Subject: [PATCH v2] docs: trace: Refactor index documentation
Date: Thu, 6 Feb 2025 19:44:53 +0530 [thread overview]
Message-ID: <20250206141453.139613-1-purvayeshi550@gmail.com> (raw)
Refactored Documentation/trace/index.rst to improve clarity, structure,
and organization. Reformatted sections, added appropriate headings.
Background of Patch:
This patch is inspired by the maintainer's suggestion on the v1 patch to
bring the documentation into real order, similar to commit '270beb5b2aae'
from Linux 6.13, improving clarity, structure, and usability.
Signed-off-by: Purva Yeshi <purvayeshi550@gmail.com>
---
V1 - https://lore.kernel.org/all/20250204133616.27694-1-purvayeshi550@gmail.com/
V2 - Refined formatting and improved section organization.
Documentation/trace/index.rst | 86 ++++++++++++++++++++++++++++++-----
1 file changed, 75 insertions(+), 11 deletions(-)
diff --git a/Documentation/trace/index.rst b/Documentation/trace/index.rst
index 2c991dc96..c4ff7e7de 100644
--- a/Documentation/trace/index.rst
+++ b/Documentation/trace/index.rst
@@ -1,39 +1,103 @@
-==========================
-Linux Tracing Technologies
-==========================
+================================
+Linux Tracing Technologies Guide
+================================
+
+Tracing in the Linux kernel is a powerful mechanism that allows
+developers and system administrators to analyze and debug system
+behavior. This guide provides documentation on various tracing
+frameworks and tools available in the Linux kernel.
+
+Introduction to Tracing
+-----------------------
+
+This section provides an overview of Linux tracing mechanisms
+and debugging approaches.
.. toctree::
- :maxdepth: 2
+ :maxdepth: 1
- ftrace-design
+ debugging
+ tracepoints
tracepoint-analysis
+
+Core Tracing Frameworks
+-----------------------
+
+The following are the primary tracing frameworks integrated into
+the Linux kernel.
+
+.. toctree::
+ :maxdepth: 1
+
ftrace
+ ftrace-design
ftrace-uses
- fprobe
kprobes
kprobetrace
uprobetracer
fprobetrace
- tracepoints
+ fprobe
+
+Event Tracing and Analysis
+--------------------------
+
+A detailed explanation of event tracing mechanisms and their
+applications.
+
+.. toctree::
+ :maxdepth: 1
+
events
events-kmem
events-power
events-nmi
events-msr
- mmiotrace
+ boottime-trace
histogram
histogram-design
- boottime-trace
- debugging
hwlat_detector
osnoise-tracer
timerlat-tracer
+
+Hardware and Performance Tracing
+--------------------------------
+
+This section covers tracing features that monitor hardware
+interactions and system performance.
+
+.. toctree::
+ :maxdepth: 1
+
intel_th
ring-buffer-design
ring-buffer-map
stm
sys-t
coresight/index
- user_events
rv/index
hisi-ptt
+
+User-space Tracing
+------------------
+
+These tools allow tracing user-space applications and
+interactions.
+
+.. toctree::
+ :maxdepth: 1
+
+ user_events
+ mmiotrace
+
+Additional Resources
+--------------------
+
+For more details, refer to the respective documentation of each
+tracing tool and framework.
+
+.. only:: subproject and html
+
+ Indices
+ =======
+
+ * :ref:`genindex`
\ No newline at end of file
--
2.34.1
next reply other threads:[~2025-02-06 14:15 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-02-06 14:14 Purva Yeshi [this message]
2025-02-10 22:45 ` Steven Rostedt
2025-02-12 11:10 ` Bagas Sanjaya
2025-02-12 14:51 ` Steven Rostedt
2025-02-13 3:31 ` Bagas Sanjaya
2025-02-13 11:56 ` Purva Yeshi
2025-02-13 16:47 ` Steven Rostedt
2025-02-13 19:12 ` Purva Yeshi
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=20250206141453.139613-1-purvayeshi550@gmail.com \
--to=purvayeshi550@gmail.com \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-trace-kernel@vger.kernel.org \
--cc=mathieu.desnoyers@efficios.com \
--cc=mhiramat@kernel.org \
--cc=rostedt@goodmis.org \
--cc=skhan@linuxfoundation.org \
/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
all inboxes | Powered by JetHome®