Skip to content

Commit 3678a33

Browse files
rddunlapaxboe
authored andcommitted
blk-stat: convert struct blk_stat_callback to kernel-doc
Most of struct blk_stat_callback documentation is already in kernel-doc format. Convert the remaining struct members to kernel-doc to avoid kernel-doc warnings: Warning: block/blk-stat.h:62 struct member 'list' not described in 'blk_stat_callback' Warning: block/blk-stat.h:62 struct member 'timer_fn' not described in 'blk_stat_callback' Warning: block/blk-stat.h:62 struct member 'rcu' not described in 'blk_stat_callback' Warning: block/blk-stat.h:133 No description found for return value of 'blk_stat_is_active' Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Reviewed-by: Chaitanya Kulkarni <kch@nvidia.com> Signed-off-by: Jens Axboe <axboe@kernel.dk>
1 parent 4c431a7 commit 3678a33

1 file changed

Lines changed: 7 additions & 2 deletions

File tree

block/blk-stat.h

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
* timer fires, @cpu_stat is flushed to @stat and @timer_fn is invoked.
1818
*/
1919
struct blk_stat_callback {
20-
/*
20+
/**
2121
* @list: RCU list of callbacks for a &struct request_queue.
2222
*/
2323
struct list_head list;
@@ -50,7 +50,7 @@ struct blk_stat_callback {
5050
struct blk_rq_stat *stat;
5151

5252
/**
53-
* @fn: Callback function.
53+
* @timer_fn: Callback function.
5454
*/
5555
void (*timer_fn)(struct blk_stat_callback *);
5656

@@ -59,6 +59,9 @@ struct blk_stat_callback {
5959
*/
6060
void *data;
6161

62+
/**
63+
* @rcu: rcu list head
64+
*/
6265
struct rcu_head rcu;
6366
};
6467

@@ -126,6 +129,8 @@ void blk_stat_free_callback(struct blk_stat_callback *cb);
126129
* blk_stat_is_active() - Check if a block statistics callback is currently
127130
* gathering statistics.
128131
* @cb: The callback.
132+
*
133+
* Returns: %true iff the callback is active.
129134
*/
130135
static inline bool blk_stat_is_active(struct blk_stat_callback *cb)
131136
{

0 commit comments

Comments
 (0)