mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
synced 2025-12-27 11:06:41 -05:00
1e9ddbb2cd
Currently, LKMM docs are not included in any of kernel documentation
books.
Commit e40573a43d ("docs: put atomic*.txt and memory-barriers.txt
into the core-api book") covered plain-text docs under Documentation/
by using the "include::" directive along with the ":literal:" option.
As LKMM docs are not under Documentation/, the same approach would not
work due to the directive's restriction.
As a matter of fact, kernel documentation has an extended directive
by the name of "kernel-include::", which loosens such restriction and
accepts any files under the kernel source tree.
Rather than moving LKMM docs around, use the latter and pull them into
the dev-tools book next to KCSAN.
Signed-off-by: Akira Yokosawa <akiyks@gmail.com>
Cc: Paul E. McKenney <paulmck@kernel.org>
Acked-by: Paul E. McKenney <paulmck@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <7ce84a93-5cbc-420e-894a-06a0372c52ab@gmail.com>
49 lines
951 B
ReStructuredText
49 lines
951 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
|
|
|
|
|
|
.. only:: subproject and html
|
|
|
|
Indices
|
|
=======
|
|
|
|
* :ref:`genindex`
|