AcoSail/kernel_optimize_test
8
0
Fork 0
forked from luck/tmp_suning_uos_patched
Code Pull Requests Activity

docs/core-api: Remove possibly confusing sub-headings from Bit Operations

Browse Source 
The recent commit 81d2c6f819 ("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 <mpe@ellerman.id.au>
This commit is contained in:
Michael Ellerman 2019-12-04 21:20:28 +11:00
parent 5bece3d661
commit 4f4afc2c95
1 changed files with 0 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
Documentation/core-api/kernel-api.rst
View File

@ -57,21 +57,12 @@ The Linux kernel provides more basic utility functions.
Bit Operations
--------------
Atomic Operations
~~~~~~~~~~~~~~~~~
.. kernel-doc:: include/asm-generic/bitops/instrumented-atomic.h
:internal:
Non-atomic Operations
~~~~~~~~~~~~~~~~~~~~~
.. kernel-doc:: include/asm-generic/bitops/instrumented-non-atomic.h
:internal:
Locking Operations
~~~~~~~~~~~~~~~~~~
.. kernel-doc:: include/asm-generic/bitops/instrumented-lock.h
:internal: