mirror of
https://github.com/torvalds/linux.git
synced 2026-05-12 16:18:45 +02:00
a592a36e49
The root document usually has a special :ref:`genindex` link to the generated index. This is also the case for Documentation/index.rst. The other index.rst files deeper in the directory hierarchy usually don't. For SPHINXDIRS builds, the root document isn't Documentation/index.rst, but some other index.rst in the hierarchy. Currently they have a ".. only::" block to add the index link when doing SPHINXDIRS html builds. This is obviously very tedious and repetitive. The link is also added to all index.rst files in the hierarchy for SPHINXDIRS builds, not just the root document. Put the boilerplate in a sphinx-includes/subproject-index.rst file, and include it at the end of the root document for subproject builds in an ad-hoc source-read extension defined in conf.py. For now, keep having the boilerplate in translations, because this approach currently doesn't cover translated index link headers. Cc: Jonathan Corbet <corbet@lwn.net> Cc: Mauro Carvalho Chehab <mchehab@kernel.org> Cc: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Jani Nikula <jani.nikula@intel.com> Tested-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Reviewed-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> [jc: did s/doctree/kern_doc_dir/ ] Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20260123143149.2024303-1-jani.nikula@intel.com>
98 lines
1.8 KiB
ReStructuredText
98 lines
1.8 KiB
ReStructuredText
================================
|
|
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
|
|
|
|
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
|
|
kprobes
|
|
kprobetrace
|
|
fprobetrace
|
|
eprobetrace
|
|
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
|
|
boottime-trace
|
|
histogram
|
|
histogram-design
|
|
|
|
Hardware and Performance Tracing
|
|
--------------------------------
|
|
|
|
This section covers tracing features that monitor hardware
|
|
interactions and system performance.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
intel_th
|
|
stm
|
|
sys-t
|
|
coresight/index
|
|
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
|
|
uprobetracer
|
|
|
|
Additional Resources
|
|
--------------------
|
|
|
|
For more details, refer to the respective documentation of each
|
|
tracing tool and framework.
|