mirror of
git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
synced 2026-03-22 07:27:12 +08: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>
41 lines
873 B
ReStructuredText
41 lines
873 B
ReStructuredText
================================
|
|
Development tools for the kernel
|
|
================================
|
|
|
|
This document is a collection of documents about development tools that can
|
|
be used to work on the kernel. For now, the documents have been pulled
|
|
together without any significant effort to integrate them into a coherent
|
|
whole; patches welcome!
|
|
|
|
A brief overview of testing-specific tools can be found in
|
|
Documentation/dev-tools/testing-overview.rst
|
|
|
|
Tools that are specific to debugging can be found in
|
|
Documentation/process/debugging/index.rst
|
|
|
|
.. toctree::
|
|
:caption: Table of contents
|
|
:maxdepth: 2
|
|
|
|
testing-overview
|
|
checkpatch
|
|
clang-format
|
|
coccinelle
|
|
sparse
|
|
kcov
|
|
gcov
|
|
kasan
|
|
kmsan
|
|
ubsan
|
|
kmemleak
|
|
kcsan
|
|
lkmm/index
|
|
kfence
|
|
kselftest
|
|
kunit/index
|
|
ktap
|
|
checkuapi
|
|
gpio-sloppy-logic-analyzer
|
|
autofdo
|
|
propeller
|