Commit 1e9ddbb2 authored by Akira Yokosawa's avatar Akira Yokosawa Committed by Jonathan Corbet
Browse files

docs: Pull LKMM documentation into dev-tools book 



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

Commit e40573a4 ("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: default avatarAkira Yokosawa <akiyks@gmail.com>
Cc: Paul E. McKenney <paulmck@kernel.org>
Acked-by: default avatarPaul E. McKenney <paulmck@kernel.org>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
Message-ID: <7ce84a93-5cbc-420e-894a-06a0372c52ab@gmail.com>
parent 9946f344

Documentation/dev-tools/index.rst

+1 −0
Original line number Diff line number Diff line
@@ -29,6 +29,7 @@ Documentation/process/debugging/index.rst 
   ubsan

   kmemleak

   kcsan

   lkmm/index

   kfence

   kselftest

   kunit/index

Documentation/dev-tools/lkmm/docs/access-marking.rst

0 → 100644
+11 −0
Original line number Diff line number Diff line 
.. SPDX-License-Identifier: GPL-2.0



Access Marking

--------------



Literal include of ``tools/memory-model/Documentation/access-marking.txt``.



------------------------------------------------------------------



.. kernel-include:: tools/memory-model/Documentation/access-marking.txt

   :literal:

Documentation/dev-tools/lkmm/docs/cheatsheet.rst

0 → 100644
+11 −0
Original line number Diff line number Diff line 
.. SPDX-License-Identifier: GPL-2.0



Cheatsheet

----------



Literal include of ``tools/memory-model/Documentation/cheatsheet.txt``.



------------------------------------------------------------------



.. kernel-include:: tools/memory-model/Documentation/cheatsheet.txt

   :literal:

Documentation/dev-tools/lkmm/docs/control-dependencies.rst

0 → 100644
+11 −0
Original line number Diff line number Diff line 
.. SPDX-License-Identifier: GPL-2.0



Control Dependencies

--------------------



Literal include of ``tools/memory-model/Documentation/control-dependencies.txt``.



------------------------------------------------------------------



.. kernel-include:: tools/memory-model/Documentation/control-dependencies.txt

   :literal:

Documentation/dev-tools/lkmm/docs/explanation.rst

0 → 100644
+11 −0
Original line number Diff line number Diff line 
.. SPDX-License-Identifier: GPL-2.0



Explanation

-----------



Literal include of ``tools/memory-model/Documentation/explanation.txt``.



------------------------------------------------------------------



.. kernel-include:: tools/memory-model/Documentation/explanation.txt

   :literal: