From: Randy Dunlap <rdunlap@infradead.org>
To: linux-kernel@vger.kernel.org
Cc: Randy Dunlap <rdunlap@infradead.org>,
Yury Norov <yury.norov@gmail.com>,
Rasmus Villemoes <linux@rasmusvillemoes.dk>,
Arnd Bergmann <arnd@arndb.de>,
linux-arch@vger.kernel.org
Subject: [PATCH] bitops: use correct parameter names in kernel-doc
Date: Fri, 27 Feb 2026 23:17:50 -0800 [thread overview]
Message-ID: <20260228071750.2663889-1-rdunlap@infradead.org> (raw)
Fix the kernel-doc comments to use the correct parameter names to
avoid kernel-doc warnings:
Warning: include/asm-generic/bitops/lock.h:19 function parameter 'p'
not described in 'arch_test_and_set_bit_lock'
Warning: include/asm-generic/bitops/lock.h:41 function parameter 'p'
not described in 'arch_clear_bit_unlock'
Warning: include/asm-generic/bitops/lock.h:59 function parameter 'p'
not described in 'arch___clear_bit_unlock'
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Yury Norov <yury.norov@gmail.com>
Cc: Rasmus Villemoes <linux@rasmusvillemoes.dk>
Cc: Arnd Bergmann <arnd@arndb.de>
Cc: linux-arch@vger.kernel.org
Note: Shouldn't this line in the MAINTAINERS file:
F: include/asm-generic/bitops
instead be
F: include/asm-generic/bitops/
include/asm-generic/bitops/lock.h | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
--- linux-next-20260211.orig/include/asm-generic/bitops/lock.h
+++ linux-next-20260211/include/asm-generic/bitops/lock.h
@@ -9,7 +9,7 @@
/**
* arch_test_and_set_bit_lock - Set a bit and return its old value, for lock
* @nr: Bit to set
- * @addr: Address to count from
+ * @p: Address to count from
*
* This operation is atomic and provides acquire barrier semantics if
* the returned value is 0.
@@ -33,7 +33,7 @@ arch_test_and_set_bit_lock(unsigned int
/**
* arch_clear_bit_unlock - Clear a bit in memory, for unlock
* @nr: the bit to set
- * @addr: the address to start counting from
+ * @p: the address to start counting from
*
* This operation is atomic and provides release barrier semantics.
*/
@@ -47,7 +47,7 @@ arch_clear_bit_unlock(unsigned int nr, v
/**
* arch___clear_bit_unlock - Clear a bit in memory, for unlock
* @nr: the bit to set
- * @addr: the address to start counting from
+ * @p: the address to start counting from
*
* A weaker form of clear_bit_unlock() as used by __bit_lock_unlock(). If all
* the bits in the word are protected by this lock some archs can use weaker
reply other threads:[~2026-02-28 7:17 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
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=20260228071750.2663889-1-rdunlap@infradead.org \
--to=rdunlap@infradead.org \
--cc=arnd@arndb.de \
--cc=linux-arch@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux@rasmusvillemoes.dk \
--cc=yury.norov@gmail.com \
/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