[PATCH] x86/barrier: use correct parameter names in kernel-doc
From: Randy Dunlap
Date: Sun Jul 19 2026 - 13:55:11 EST
Use the correct macro parameter names in the kernel-doc comments
to avoid kernel-doc warnings:
Warning: arch/x86/include/asm/barrier.h:35 function parameter 'idx' not
described in 'array_index_mask_nospec'
Warning: arch/x86/include/asm/barrier.h:35 function parameter 'sz' not
described in 'array_index_mask_nospec'
Warning: arch/x86/include/asm/barrier.h:35 Excess function parameter
'index' description in 'array_index_mask_nospec'
Warning: arch/x86/include/asm/barrier.h:35 Excess function parameter
'size' description in 'array_index_mask_nospec'
Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
---
Cc: Thomas Gleixner <tglx@xxxxxxxxxx>
Cc: Ingo Molnar <mingo@xxxxxxxxxx>
Cc: Borislav Petkov <bp@xxxxxxxxx>
Cc: Dave Hansen <dave.hansen@xxxxxxxxxxxxxxx>
Cc: x86@xxxxxxxxxx
Cc: "H. Peter Anvin" <hpa@xxxxxxxxx>
arch/x86/include/asm/barrier.h | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
--- linux-next-20260717.orig/arch/x86/include/asm/barrier.h
+++ linux-next-20260717/arch/x86/include/asm/barrier.h
@@ -27,11 +27,11 @@
/**
* array_index_mask_nospec() - generate a mask that is ~0UL when the
* bounds check succeeds and 0 otherwise
- * @index: array element index
- * @size: number of elements in array
+ * @idx: array element index
+ * @sz: number of elements in array
*
* Returns:
- * 0 - (index < size)
+ * 0 - (@idx < @sz)
*/
#define array_index_mask_nospec(idx,sz) ({ \
typeof((idx)+(sz)) __idx = (idx); \