Commit e40573a4 authored by Jonathan Corbet's avatar Jonathan Corbet
Browse files

docs: put atomic*.txt and memory-barriers.txt into the core-api book 



These files describe part of the core API, but have never been converted to
RST due to ... let's say local oppposition.  So, create a set of
special-purpose wrappers to ..include these files into a separate page so
that they can be a part of the htmldocs build.  Then link them into the
core-api manual and remove them from the "staging" dumping ground.

Acked-by: default avatarJani Nikula <jani.nikula@intel.com>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
Reviewed-by: default avatarDavid Vernet <void@manifault.com>
Acked-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Link: https://lore.kernel.org/r/20220927160559.97154-7-corbet@lwn.net


Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent f4bf1cd4

Documentation/core-api/index.rst

+3 −0
Original line number Diff line number Diff line
@@ -45,6 +45,8 @@ Library functionality that is used throughout the kernel. 
   this_cpu_ops

   timekeeping

   errseq

   wrappers/atomic_t

   wrappers/atomic_bitops



Low level entry and exit

========================
@@ -68,6 +70,7 @@ Documentation/locking/index.rst for more related documentation. 
   local_ops

   padata

   ../RCU/index

   wrappers/memory-barriers.rst



Low-level hardware management

=============================

Documentation/core-api/wrappers/atomic_bitops.rst

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

   This is a simple wrapper to bring atomic_bitops.txt into the RST world

   until such a time as that file can be converted directly.



=============

Atomic bitops

=============



.. raw:: latex



    \footnotesize



.. include:: ../../atomic_bitops.txt

   :literal:



.. raw:: latex



    \normalsize

Documentation/core-api/wrappers/atomic_t.rst

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

   This is a simple wrapper to bring atomic_t.txt into the RST world

   until such a time as that file can be converted directly.



============

Atomic types

============



.. raw:: latex



    \footnotesize



.. include:: ../../atomic_t.txt

   :literal:



.. raw:: latex



    \normalsize

Documentation/core-api/wrappers/memory-barriers.rst

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

   This is a simple wrapper to bring memory-barriers.txt into the RST world

   until such a time as that file can be converted directly.



============================

Linux kernel memory barriers

============================



.. raw:: latex



    \footnotesize



.. include:: ../../memory-barriers.txt

   :literal:



.. raw:: latex



    \normalsize

Documentation/staging/index.rst

+0 −42
Original line number Diff line number Diff line
@@ -14,45 +14,3 @@ Unsorted Documentation 
   static-keys

   tee

   xz
 


Atomic Types

============



.. raw:: latex



    \footnotesize



.. include:: ../atomic_t.txt

   :literal:



.. raw:: latex



    \normalsize



Atomic bitops

=============



.. raw:: latex



    \footnotesize



.. include:: ../atomic_bitops.txt

   :literal:



.. raw:: latex



    \normalsize



Memory Barriers

===============



.. raw:: latex



    \footnotesize



.. include:: ../memory-barriers.txt

   :literal:



.. raw:: latex



    \normalsize