Skip to content

Commit e40573a

Browse files
author
Jonathan Corbet
committed
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: Jani Nikula <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]> Reviewed-by: David Vernet <[email protected]> Acked-by: Randy Dunlap <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Jonathan Corbet <[email protected]>
1 parent f4bf1cd commit e40573a

File tree

5 files changed

+58
-42
lines changed

5 files changed

+58
-42
lines changed

Documentation/core-api/index.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,8 @@ Library functionality that is used throughout the kernel.
4545
this_cpu_ops
4646
timekeeping
4747
errseq
48+
wrappers/atomic_t
49+
wrappers/atomic_bitops
4850

4951
Low level entry and exit
5052
========================
@@ -68,6 +70,7 @@ Documentation/locking/index.rst for more related documentation.
6870
local_ops
6971
padata
7072
../RCU/index
73+
wrappers/memory-barriers.rst
7174

7275
Low-level hardware management
7376
=============================
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
.. SPDX-License-Identifier: GPL-2.0
2+
This is a simple wrapper to bring atomic_bitops.txt into the RST world
3+
until such a time as that file can be converted directly.
4+
5+
=============
6+
Atomic bitops
7+
=============
8+
9+
.. raw:: latex
10+
11+
\footnotesize
12+
13+
.. include:: ../../atomic_bitops.txt
14+
:literal:
15+
16+
.. raw:: latex
17+
18+
\normalsize
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
.. SPDX-License-Identifier: GPL-2.0
2+
This is a simple wrapper to bring atomic_t.txt into the RST world
3+
until such a time as that file can be converted directly.
4+
5+
============
6+
Atomic types
7+
============
8+
9+
.. raw:: latex
10+
11+
\footnotesize
12+
13+
.. include:: ../../atomic_t.txt
14+
:literal:
15+
16+
.. raw:: latex
17+
18+
\normalsize
19+
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
.. SPDX-License-Identifier: GPL-2.0
2+
This is a simple wrapper to bring memory-barriers.txt into the RST world
3+
until such a time as that file can be converted directly.
4+
5+
============================
6+
Linux kernel memory barriers
7+
============================
8+
9+
.. raw:: latex
10+
11+
\footnotesize
12+
13+
.. include:: ../../memory-barriers.txt
14+
:literal:
15+
16+
.. raw:: latex
17+
18+
\normalsize

Documentation/staging/index.rst

Lines changed: 0 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -14,45 +14,3 @@ Unsorted Documentation
1414
static-keys
1515
tee
1616
xz
17-
18-
Atomic Types
19-
============
20-
21-
.. raw:: latex
22-
23-
\footnotesize
24-
25-
.. include:: ../atomic_t.txt
26-
:literal:
27-
28-
.. raw:: latex
29-
30-
\normalsize
31-
32-
Atomic bitops
33-
=============
34-
35-
.. raw:: latex
36-
37-
\footnotesize
38-
39-
.. include:: ../atomic_bitops.txt
40-
:literal:
41-
42-
.. raw:: latex
43-
44-
\normalsize
45-
46-
Memory Barriers
47-
===============
48-
49-
.. raw:: latex
50-
51-
\footnotesize
52-
53-
.. include:: ../memory-barriers.txt
54-
:literal:
55-
56-
.. raw:: latex
57-
58-
\normalsize

0 commit comments

Comments
 (0)