From: Randy Dunlap <rdunlap@infradead.org>
To: linux-kernel@vger.kernel.org
Cc: Randy Dunlap <rdunlap@infradead.org>,
Peter Zijlstra <peterz@infradead.org>,
Ingo Molnar <mingo@redhat.com>,
Arnaldo Carvalho de Melo <acme@kernel.org>,
Namhyung Kim <namhyung@kernel.org>,
Thomas Gleixner <tglx@kernel.org>, Borislav Petkov <bp@alien8.de>,
Dave Hansen <dave.hansen@linux.intel.com>,
"H. Peter Anvin" <hpa@zytor.com>,
Josh Poimboeuf <jpoimboe@kernel.org>,
x86@kernel.org, linux-perf-users@vger.kernel.org
Subject: [PATCH 2/5 RESEND] x86/barrier: use correct parameter names in kernel-doc
Date: Thu, 30 Jul 2026 16:34:26 -0700 [thread overview]
Message-ID: <20260730233429.285788-3-rdunlap@infradead.org> (raw)
In-Reply-To: <20260730233429.285788-1-rdunlap@infradead.org>
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: "H. Peter Anvin" <hpa@zytor.com>
Cc: x86@kernel.org
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); \
next prev parent reply other threads:[~2026-07-30 23:34 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-07-30 23:34 [PATCH 0/5] x86: clean up some kernel-doc comments Randy Dunlap
2026-07-30 23:34 ` [PATCH 1/5] perf/x86/intel/pt: drop kernel-doc for deleted struct members Randy Dunlap
2026-07-30 23:34 ` Randy Dunlap [this message]
2026-07-30 23:34 ` [PATCH 3/5 RESEND] x86/lib: checksum_64.h: eliminate all kernel-doc warnings Randy Dunlap
2026-07-30 23:34 ` [PATCH 4/5] x86/speculation: drop Excess function parameter descriptions Randy Dunlap
2026-07-30 23:34 ` [PATCH 5/5] x86/intel/quark: clean up function kernel-doc Randy Dunlap
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20260730233429.285788-3-rdunlap@infradead.org \
--to=rdunlap@infradead.org \
--cc=acme@kernel.org \
--cc=bp@alien8.de \
--cc=dave.hansen@linux.intel.com \
--cc=hpa@zytor.com \
--cc=jpoimboe@kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-perf-users@vger.kernel.org \
--cc=mingo@redhat.com \
--cc=namhyung@kernel.org \
--cc=peterz@infradead.org \
--cc=tglx@kernel.org \
--cc=x86@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox