• Michael Ellerman's avatar
    docs/core-api: Remove possibly confusing sub-headings from Bit Operations · 4f4afc2c
    Michael Ellerman authored
    The recent commit 81d2c6f8 ("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: default avatarMichael Ellerman <mpe@ellerman.id.au>
    4f4afc2c
kernel-api.rst 8.08 KB