]> git.ipfire.org Git - thirdparty/kernel/stable.git/commit
docs: Pull LKMM documentation into dev-tools book
authorAkira Yokosawa <akiyks@gmail.com>
Thu, 11 Sep 2025 08:29:31 +0000 (17:29 +0900)
committerJonathan Corbet <corbet@lwn.net>
Tue, 16 Sep 2025 16:12:02 +0000 (10:12 -0600)
commit1e9ddbb2cd346e42256c5ede2cc40439f2f99bb7
tree56e8d0643b7a4c7a711da1f8a9b648656cb77911
parent9946f344528afabb8620a5c3b788cfa505211517
docs: Pull LKMM documentation into dev-tools book

Currently, LKMM docs are not included in any of kernel documentation
books.

Commit e40573a43d16 ("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>
18 files changed:
Documentation/dev-tools/index.rst
Documentation/dev-tools/lkmm/docs/access-marking.rst [new file with mode: 0644]
Documentation/dev-tools/lkmm/docs/cheatsheet.rst [new file with mode: 0644]
Documentation/dev-tools/lkmm/docs/control-dependencies.rst [new file with mode: 0644]
Documentation/dev-tools/lkmm/docs/explanation.rst [new file with mode: 0644]
Documentation/dev-tools/lkmm/docs/glossary.rst [new file with mode: 0644]
Documentation/dev-tools/lkmm/docs/herd-representation.rst [new file with mode: 0644]
Documentation/dev-tools/lkmm/docs/index.rst [new file with mode: 0644]
Documentation/dev-tools/lkmm/docs/litmus-tests.rst [new file with mode: 0644]
Documentation/dev-tools/lkmm/docs/locking.rst [new file with mode: 0644]
Documentation/dev-tools/lkmm/docs/ordering.rst [new file with mode: 0644]
Documentation/dev-tools/lkmm/docs/readme.rst [new file with mode: 0644]
Documentation/dev-tools/lkmm/docs/recipes.rst [new file with mode: 0644]
Documentation/dev-tools/lkmm/docs/references.rst [new file with mode: 0644]
Documentation/dev-tools/lkmm/docs/simple.rst [new file with mode: 0644]
Documentation/dev-tools/lkmm/index.rst [new file with mode: 0644]
Documentation/dev-tools/lkmm/readme.rst [new file with mode: 0644]
MAINTAINERS