[PATCH] x86/barrier: use correct parameter names in kernel-doc

Randy Dunlap posted 1 patch 5 days, 9 hours ago
arch/x86/include/asm/barrier.h |    6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
[PATCH] x86/barrier: use correct parameter names in kernel-doc
Posted by Randy Dunlap 5 days, 9 hours ago
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@infradead.org>
---
Cc: Thomas Gleixner <tglx@kernel.org>
Cc: Ingo Molnar <mingo@redhat.com>
Cc: Borislav Petkov <bp@alien8.de>
Cc: Dave Hansen <dave.hansen@linux.intel.com>
Cc: x86@kernel.org
Cc: "H. Peter Anvin" <hpa@zytor.com>

 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);	\