tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
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 <jani.nikula@intel.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Reviewed-by: David Vernet <void@manifault.com>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Link: https://lore.kernel.org/r/20220927160559.97154-7-corbet@lwn.net
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
+58
-42
+3
Documentation/core-api/index.rst
+3
Documentation/core-api/index.rst
···
45
45
this_cpu_ops
46
46
timekeeping
47
47
errseq
48
+
wrappers/atomic_t
49
+
wrappers/atomic_bitops
48
50
49
51
Low level entry and exit
50
52
========================
···
70
68
local_ops
71
69
padata
72
70
../RCU/index
71
+
wrappers/memory-barriers.rst
73
72
74
73
Low-level hardware management
75
74
=============================
+18
Documentation/core-api/wrappers/atomic_bitops.rst
+18
Documentation/core-api/wrappers/atomic_bitops.rst
···
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
+19
Documentation/core-api/wrappers/atomic_t.rst
+19
Documentation/core-api/wrappers/atomic_t.rst
···
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
+
+18
Documentation/core-api/wrappers/memory-barriers.rst
+18
Documentation/core-api/wrappers/memory-barriers.rst
···
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
-42
Documentation/staging/index.rst
-42
Documentation/staging/index.rst
···
14
14
static-keys
15
15
tee
16
16
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