Skip to content

Commit 4f4afc2

Browse files
committed
docs/core-api: Remove possibly confusing sub-headings from Bit Operations
The recent commit 81d2c6f ("kasan: support instrumented bitops combined with generic bitops"), split the KASAN instrumented bitops into separate headers for atomic, non-atomic and locking operations. This was done to allow arches to include just the instrumented bitops they need, while also using some of the generic bitops in asm-generic/bitops (which are automatically instrumented). The generic bitops are already split into atomic, non-atomic and locking headers. This split required an update to kernel-api.rst because it included include/asm-generic/bitops-instrumented.h, which no longer exists. So now kernel-api.rst includes all three instrumented headers to get the definitions for all the bitops. When adding the three headers it seemed sensible to add sub-headings for each, ie. "Atomic", "Non-atomic" and "Locking". The confusion is that test_bit() is (and always has been) in non-atomic.h, but is documented elsewhere (atomic_bitops.txt) as being atomic. So having it appear under the "Non-atomic" heading is possibly confusing. Probably test_bit() should move from bitops/non-atomic.h to atomic.h, but that has flow on effects. For now just remove the newly added sub-headings in the documentation, so we at least aren't adding to the confusion about whether test_bit() is atomic or not. Signed-off-by: Michael Ellerman <[email protected]>
1 parent 5bece3d commit 4f4afc2

File tree

1 file changed

+0
-9
lines changed

1 file changed

+0
-9
lines changed

Documentation/core-api/kernel-api.rst

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -57,21 +57,12 @@ The Linux kernel provides more basic utility functions.
5757
Bit Operations
5858
--------------
5959

60-
Atomic Operations
61-
~~~~~~~~~~~~~~~~~
62-
6360
.. kernel-doc:: include/asm-generic/bitops/instrumented-atomic.h
6461
:internal:
6562

66-
Non-atomic Operations
67-
~~~~~~~~~~~~~~~~~~~~~
68-
6963
.. kernel-doc:: include/asm-generic/bitops/instrumented-non-atomic.h
7064
:internal:
7165

72-
Locking Operations
73-
~~~~~~~~~~~~~~~~~~
74-
7566
.. kernel-doc:: include/asm-generic/bitops/instrumented-lock.h
7667
:internal:
7768

0 commit comments

Comments
 (0)