torvalds/linux
3
0
Fork 0
mirror of git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git synced 2026-03-22 07:27:12 +08:00
Code Issues Packages Projects Releases Wiki Activity

blk-stat: convert struct blk_stat_callback to kernel-doc

Browse Source 
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>
This commit is contained in:
Randy Dunlap
2026-02-15 21:29:51 -08:00
committed by Jens Axboe
parent 4c431a76a2
commit 3678a334a5
1 changed files with 7 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
block/blk-stat.h
View File

@@ -17,7 +17,7 @@
* timer fires, @cpu_stat is flushed to @stat and @timer_fn is invoked. * timer fires, @cpu_stat is flushed to @stat and @timer_fn is invoked.
*/ */
struct blk_stat_callback { struct blk_stat_callback {
/* /**
* @list: RCU list of callbacks for a &struct request_queue. * @list: RCU list of callbacks for a &struct request_queue.
*/ */
struct list_head list; struct list_head list;
@@ -50,7 +50,7 @@ struct blk_stat_callback {
struct blk_rq_stat *stat; struct blk_rq_stat *stat;
/** /**
* @fn: Callback function. * @timer_fn: Callback function.
*/ */
void (*timer_fn)(struct blk_stat_callback *); void (*timer_fn)(struct blk_stat_callback *);
@@ -59,6 +59,9 @@ struct blk_stat_callback {
*/ */
void *data; void *data;
/**
* @rcu: rcu list head
*/
struct rcu_head rcu; struct rcu_head rcu;
}; };
@@ -126,6 +129,8 @@ void blk_stat_free_callback(struct blk_stat_callback *cb);
* blk_stat_is_active() - Check if a block statistics callback is currently * blk_stat_is_active() - Check if a block statistics callback is currently
* gathering statistics. * gathering statistics.
* @cb: The callback. * @cb: The callback.
*
* Returns: %true iff the callback is active.
*/ */
static inline bool blk_stat_is_active(struct blk_stat_callback *cb) static inline bool blk_stat_is_active(struct blk_stat_callback *cb)
{ {