mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
synced 2026-03-03 18:28:01 +01: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>
72 lines
2.3 KiB
ReStructuredText
72 lines
2.3 KiB
ReStructuredText
.. SPDX-License-Identifier: GPL-2.0
|
|
|
|
============================================
|
|
Debugging advice for Linux Kernel developers
|
|
============================================
|
|
|
|
general guides
|
|
--------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
driver_development_debugging_guide
|
|
gdb-kernel-debugging
|
|
kgdb
|
|
userspace_debugging_guide
|
|
|
|
subsystem specific guides
|
|
-------------------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
media_specific_debugging_guide
|
|
|
|
General debugging advice
|
|
========================
|
|
|
|
Depending on the issue, a different set of tools is available to track down the
|
|
problem or even to realize whether there is one in the first place.
|
|
|
|
As a first step you have to figure out what kind of issue you want to debug.
|
|
Depending on the answer, your methodology and choice of tools may vary.
|
|
|
|
Do I need to debug with limited access?
|
|
---------------------------------------
|
|
|
|
Do you have limited access to the machine or are you unable to stop the running
|
|
execution?
|
|
|
|
In this case your debugging capability depends on built-in debugging support of
|
|
provided distribution kernel.
|
|
The :doc:`/process/debugging/userspace_debugging_guide` provides a brief
|
|
overview over a range of possible debugging tools in that situation. You can
|
|
check the capability of your kernel, in most cases, by looking into config file
|
|
within the /boot directory.
|
|
|
|
Do I have root access to the system?
|
|
------------------------------------
|
|
|
|
Are you easily able to replace the module in question or to install a new
|
|
kernel?
|
|
|
|
In that case your range of available tools is a lot bigger, you can find the
|
|
tools in the :doc:`/process/debugging/driver_development_debugging_guide`.
|
|
|
|
Is timing a factor?
|
|
-------------------
|
|
|
|
It is important to understand if the problem you want to debug manifests itself
|
|
consistently (i.e. given a set of inputs you always get the same, incorrect
|
|
output), or inconsistently. If it manifests itself inconsistently, some timing
|
|
factor might be at play. If inserting delays into the code does change the
|
|
behavior, then quite likely timing is a factor.
|
|
|
|
When timing does alter the outcome of the code execution using a simple
|
|
printk() for debugging purposes may not work, a similar alternative is to use
|
|
trace_printk() , which logs the debug messages to the trace file instead of the
|
|
kernel log.
|
|
|
|
**Copyright** ©2024 : Collabora
|