* [PATCH] sbitmap: fix all kernel-doc warnings
@ 2025-11-28 6:57 Randy Dunlap
2025-11-28 16:22 ` Jens Axboe
0 siblings, 1 reply; 2+ messages in thread
From: Randy Dunlap @ 2025-11-28 6:57 UTC (permalink / raw)
To: linux-kernel; +Cc: Randy Dunlap, Jens Axboe, linux-block
Modify kernel-doc comments in sbitmap.h to prevent warnings:
Warning: include/linux/sbitmap.h:84 struct member 'alloc_hint' not
described in 'sbitmap'
Warning: include/linux/sbitmap.h:151 struct member 'ws_active' not
described in 'sbitmap_queue'
Warning: include/linux/sbitmap.h:552 No description found for
return value of 'sbq_wait_ptr'
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Jens Axboe <axboe@kernel.dk>
Cc: linux-block@vger.kernel.org
---
include/linux/sbitmap.h | 6 ++++--
1 file changed, 4 insertions(+), 2 deletions(-)
--- linux-next-20251127.orig/include/linux/sbitmap.h
+++ linux-next-20251127/include/linux/sbitmap.h
@@ -75,7 +75,7 @@ struct sbitmap {
*/
struct sbitmap_word *map;
- /*
+ /**
* @alloc_hint: Cache of last successfully allocated or freed bit.
*
* This is per-cpu, which allows multiple users to stick to different
@@ -128,7 +128,7 @@ struct sbitmap_queue {
*/
struct sbq_wait_state *ws;
- /*
+ /**
* @ws_active: count of currently active ws waitqueues
*/
atomic_t ws_active;
@@ -547,6 +547,8 @@ static inline void sbq_index_atomic_inc(
* sbitmap_queue.
* @sbq: Bitmap queue to wait on.
* @wait_index: A counter per "user" of @sbq.
+ *
+ * Return: Next wait queue to be used
*/
static inline struct sbq_wait_state *sbq_wait_ptr(struct sbitmap_queue *sbq,
atomic_t *wait_index)
^ permalink raw reply [flat|nested] 2+ messages in thread
* Re: [PATCH] sbitmap: fix all kernel-doc warnings
2025-11-28 6:57 [PATCH] sbitmap: fix all kernel-doc warnings Randy Dunlap
@ 2025-11-28 16:22 ` Jens Axboe
0 siblings, 0 replies; 2+ messages in thread
From: Jens Axboe @ 2025-11-28 16:22 UTC (permalink / raw)
To: linux-kernel, Randy Dunlap; +Cc: linux-block
On Thu, 27 Nov 2025 22:57:54 -0800, Randy Dunlap wrote:
> Modify kernel-doc comments in sbitmap.h to prevent warnings:
>
> Warning: include/linux/sbitmap.h:84 struct member 'alloc_hint' not
> described in 'sbitmap'
> Warning: include/linux/sbitmap.h:151 struct member 'ws_active' not
> described in 'sbitmap_queue'
> Warning: include/linux/sbitmap.h:552 No description found for
> return value of 'sbq_wait_ptr'
>
> [...]
Applied, thanks!
[1/1] sbitmap: fix all kernel-doc warnings
commit: 418de94e7593081c29066555bf9059f1f7dd9d79
Best regards,
--
Jens Axboe
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2025-11-28 16:22 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2025-11-28 6:57 [PATCH] sbitmap: fix all kernel-doc warnings Randy Dunlap
2025-11-28 16:22 ` Jens Axboe
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®