| Message ID | 20250318113230.24950-2-purvayeshi550@gmail.com (mailing list archive) |
|---|---|
| State | New |
| Headers | show |
| Series | [v4,1/2] docs: tracing: Reduce maxdepth in index.rst for clarity | expand |
On Tue, Mar 18, 2025 at 05:02:30PM +0530, Purva Yeshi wrote: > diff --git a/Documentation/trace/index.rst b/Documentation/trace/index.rst > index fecc4adf7..5ddd47ee7 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: 1 > > - ftrace-design > + debugging > + tracepoints > tracepoint-analysis > + ring-buffer-map > + > +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 > + ring-buffer-design > + > +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 > + mmiotrace > + hwlat_detector > + osnoise-tracer > + timerlat-tracer > + > +User-Space Tracing > +------------------ > + > +These tools allow tracing user-space applications and > +interactions. > + > +.. toctree:: > + :maxdepth: 1 > + > + user_events > + > +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 LGTM, thanks! Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>
On Tue, 18 Mar 2025 17:02:30 +0530 Purva Yeshi <purvayeshi550@gmail.com> wrote: > Refactor Documentation/trace/index.rst to improve clarity, structure, > and organization. Reformat sections and add appropriate headings for > better readability. > > Improve section grouping and refine descriptions for better usability. > > Signed-off-by: Purva Yeshi <purvayeshi550@gmail.com> > --- > Documentation/trace/index.rst | 94 +++++++++++++++++++++++++++++------ > 1 file changed, 79 insertions(+), 15 deletions(-) For both patches: Acked-by: Steven Rostedt (Google) <rostedt@goodmis.org. Jon, Feel free to apply these to your tree. Thanks, -- Steve
diff --git a/Documentation/trace/index.rst b/Documentation/trace/index.rst index fecc4adf7..5ddd47ee7 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: 1 - ftrace-design + debugging + tracepoints tracepoint-analysis + ring-buffer-map + +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 + ring-buffer-design + +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 + mmiotrace + hwlat_detector + osnoise-tracer + timerlat-tracer + +User-Space Tracing +------------------ + +These tools allow tracing user-space applications and +interactions. + +.. toctree:: + :maxdepth: 1 + + user_events + +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
Refactor Documentation/trace/index.rst to improve clarity, structure, and organization. Reformat sections and add appropriate headings for better readability. Improve section grouping and refine descriptions for better usability. Signed-off-by: Purva Yeshi <purvayeshi550@gmail.com> --- Documentation/trace/index.rst | 94 +++++++++++++++++++++++++++++------ 1 file changed, 79 insertions(+), 15 deletions(-)