diff options
| author | Akira Yokosawa <akiyks@gmail.com> | 2025-09-11 17:29:31 +0900 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2025-09-16 10:12:02 -0600 |
| commit | 1e9ddbb2cd346e42256c5ede2cc40439f2f99bb7 (patch) | |
| tree | 56e8d0643b7a4c7a711da1f8a9b648656cb77911 /Documentation/dev-tools/lkmm/docs/readme.rst | |
| parent | 9946f344528afabb8620a5c3b788cfa505211517 (diff) | |
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>
Diffstat (limited to 'Documentation/dev-tools/lkmm/docs/readme.rst')
| -rw-r--r-- | Documentation/dev-tools/lkmm/docs/readme.rst | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/Documentation/dev-tools/lkmm/docs/readme.rst b/Documentation/dev-tools/lkmm/docs/readme.rst new file mode 100644 index 000000000000..51e7a64e4435 --- /dev/null +++ b/Documentation/dev-tools/lkmm/docs/readme.rst @@ -0,0 +1,11 @@ +.. SPDX-License-Identifier: GPL-2.0 + +README (for LKMM Documentation) +------------------------------- + +Literal include of ``tools/memory-model/Documentation/README``. + +------------------------------------------------------------------ + +.. kernel-include:: tools/memory-model/Documentation/README + :literal: |