Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

Documentation: trace: Refactor toctree

Refactor table of contents of kernel tracing subsystem docs to improve
clarity, structure, and organization:

- Reformat sections and add appropriate headings
- Improve section grouping and refine descriptions for each group
- Add docs intro paragraph

Signed-off-by: Purva Yeshi <purvayeshi550@gmail.com>
Link: https://lore.kernel.org/r/20250318113230.24950-2-purvayeshi550@gmail.com
[Bagas: massage commit message and address reviews]
Co-developed-by: Bagas Sanjaya <bagasdotme@gmail.com>
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
Acked-by: Steven Rostedt (Google) <rostedt@goodmis.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>

authored by

Purva Yeshi and committed by
Jonathan Corbet
f0ba72e6 33583537

+80 -16
+80 -16
Documentation/trace/index.rst
··· 1 - ========================== 2 - Linux Tracing Technologies 3 - ========================== 1 + ================================ 2 + Linux Tracing Technologies Guide 3 + ================================ 4 + 5 + Tracing in the Linux kernel is a powerful mechanism that allows 6 + developers and system administrators to analyze and debug system 7 + behavior. This guide provides documentation on various tracing 8 + frameworks and tools available in the Linux kernel. 9 + 10 + Introduction to Tracing 11 + ----------------------- 12 + 13 + This section provides an overview of Linux tracing mechanisms 14 + and debugging approaches. 4 15 5 16 .. toctree:: 6 17 :maxdepth: 1 7 18 8 - ftrace-design 19 + debugging 20 + tracepoints 9 21 tracepoint-analysis 22 + ring-buffer-map 23 + 24 + Core Tracing Frameworks 25 + ----------------------- 26 + 27 + The following are the primary tracing frameworks integrated into 28 + the Linux kernel. 29 + 30 + .. toctree:: 31 + :maxdepth: 1 32 + 10 33 ftrace 34 + ftrace-design 11 35 ftrace-uses 12 - fprobe 13 36 kprobes 14 37 kprobetrace 15 - uprobetracer 16 38 fprobetrace 17 - tracepoints 39 + fprobe 40 + ring-buffer-design 41 + 42 + Event Tracing and Analysis 43 + -------------------------- 44 + 45 + A detailed explanation of event tracing mechanisms and their 46 + applications. 47 + 48 + .. toctree:: 49 + :maxdepth: 1 50 + 18 51 events 19 52 events-kmem 20 53 events-power 21 54 events-nmi 22 55 events-msr 23 - mmiotrace 56 + boottime-trace 24 57 histogram 25 58 histogram-design 26 - boottime-trace 27 - debugging 28 - hwlat_detector 29 - osnoise-tracer 30 - timerlat-tracer 59 + 60 + Hardware and Performance Tracing 61 + -------------------------------- 62 + 63 + This section covers tracing features that monitor hardware 64 + interactions and system performance. 65 + 66 + .. toctree:: 67 + :maxdepth: 1 68 + 31 69 intel_th 32 - ring-buffer-design 33 - ring-buffer-map 34 70 stm 35 71 sys-t 36 72 coresight/index 37 - user_events 38 73 rv/index 39 74 hisi-ptt 75 + mmiotrace 76 + hwlat_detector 77 + osnoise-tracer 78 + timerlat-tracer 79 + 80 + User-Space Tracing 81 + ------------------ 82 + 83 + These tools allow tracing user-space applications and 84 + interactions. 85 + 86 + .. toctree:: 87 + :maxdepth: 1 88 + 89 + user_events 90 + uprobetracer 91 + 92 + Additional Resources 93 + -------------------- 94 + 95 + For more details, refer to the respective documentation of each 96 + tracing tool and framework. 97 + 98 + .. only:: subproject and html 99 + 100 + Indices 101 + ======= 102 + 103 + * :ref:`genindex`