• Randy Dunlap's avatar
    x86: Fix kernel-doc atomic.h warnings · 4331f4d5
    Randy Dunlap authored
    Fix kernel-doc warnings in arch/x86/include/asm/atomic.h that are caused by
    having a #define macro between the kernel-doc notation and the function
    name.  Fixed by moving the #define macro to after the function
    implementation.
    
    Make the same change for atomic64_{32,64}.h for consistency even though
    there were no kernel-doc warnings found in these header files, but there
    would be if they were used in generation of documentation.
    
    Fixes these kernel-doc warnings:
    
    ../arch/x86/include/asm/atomic.h:84: warning: Excess function parameter 'i' description in 'arch_atomic_sub_and_test'
    ../arch/x86/include/asm/atomic.h:84: warning: Excess function parameter 'v' description in 'arch_atomic_sub_and_test'
    ../arch/x86/include/asm/atomic.h:96: warning: Excess function parameter 'v' description in 'arch_atomic_inc'
    ../arch/x86/include/asm/atomic.h:109: warning: Excess function parameter 'v' description in 'arch_atomic_dec'
    ../arch/x86/include/asm/atomic.h:124: warning: Excess function parameter 'v' description in 'arch_atomic_dec_and_test'
    ../arch/x86/include/asm/atomic.h:138: warning: Excess function parameter 'v' description in 'arch_atomic_inc_and_test'
    ../arch/x86/include/asm/atomic.h:153: warning: Excess function parameter 'i' description in 'arch_atomic_add_negative'
    ../arch/x86/include/asm/atomic.h:153: warning: Excess function parameter 'v' description in 'arch_atomic_add_negative'
    
    Fixes: 18cc1814 ("atomics/treewide: Make test ops optional")
    Signed-off-by: default avatarRandy Dunlap <rdunlap@infradead.org>
    Signed-off-by: default avatarThomas Gleixner <tglx@linutronix.de>
    Cc: Mark Rutland <mark.rutland@arm.com>
    Link: https://lkml.kernel.org/r/0a1e678d-c8c5-b32c-2640-ed4e94d399d2@infradead.org
    
    4331f4d5
atomic.h 6.12 KB