[PATCH] sbitmap: fix all kernel-doc warnings

Randy Dunlap posted 1 patch 3 days, 13 hours ago
include/linux/sbitmap.h |    6 ++++--
1 file changed, 4 insertions(+), 2 deletions(-)
[PATCH] sbitmap: fix all kernel-doc warnings
Posted by Randy Dunlap 3 days, 13 hours ago
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)
Re: [PATCH] sbitmap: fix all kernel-doc warnings
Posted by Jens Axboe 3 days, 4 hours ago
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