Skip to content

Commit 418de94

Browse files
rddunlapaxboe
authored andcommitted
sbitmap: fix all kernel-doc warnings
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> Signed-off-by: Jens Axboe <axboe@kernel.dk>
1 parent 28d7a37 commit 418de94

1 file changed

Lines changed: 4 additions & 2 deletions

File tree

include/linux/sbitmap.h

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ struct sbitmap {
7575
*/
7676
struct sbitmap_word *map;
7777

78-
/*
78+
/**
7979
* @alloc_hint: Cache of last successfully allocated or freed bit.
8080
*
8181
* This is per-cpu, which allows multiple users to stick to different
@@ -128,7 +128,7 @@ struct sbitmap_queue {
128128
*/
129129
struct sbq_wait_state *ws;
130130

131-
/*
131+
/**
132132
* @ws_active: count of currently active ws waitqueues
133133
*/
134134
atomic_t ws_active;
@@ -547,6 +547,8 @@ static inline void sbq_index_atomic_inc(atomic_t *index)
547547
* sbitmap_queue.
548548
* @sbq: Bitmap queue to wait on.
549549
* @wait_index: A counter per "user" of @sbq.
550+
*
551+
* Return: Next wait queue to be used
550552
*/
551553
static inline struct sbq_wait_state *sbq_wait_ptr(struct sbitmap_queue *sbq,
552554
atomic_t *wait_index)

0 commit comments

Comments
 (0)