[PATCH] blk-stat: convert struct blk_stat_callback to kernel-doc

[PATCH] blk-stat: convert struct blk_stat_callback to kernel-doc

[Randy Dunlap]

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'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Jens Axboe <axboe@kernel.dk>
Cc: linux-block@vger.kernel.org
---
 block/blk-stat.h |    7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

--- linux-next-20251029.orig/block/blk-stat.h
+++ linux-next-20251029/block/blk-stat.h
@@ -17,7 +17,7 @@
  * timer fires, @cpu_stat is flushed to @stat and @timer_fn is invoked.
  */
 struct blk_stat_callback {
-	/*
+	/**
 	 * @list: RCU list of callbacks for a &struct request_queue.
 	 */
 	struct list_head list;
@@ -50,7 +50,7 @@ struct blk_stat_callback {
 	struct blk_rq_stat *stat;
 
 	/**
-	 * @fn: Callback function.
+	 * @timer_fn: Callback function.
 	 */
 	void (*timer_fn)(struct blk_stat_callback *);
 
@@ -59,6 +59,9 @@ struct blk_stat_callback {
 	 */
 	void *data;
 
+	/**
+	 * @rcu: rcu list head
+	 */
 	struct rcu_head rcu;
 };
 

Re: [PATCH] blk-stat: convert struct blk_stat_callback to kernel-doc

[Chaitanya Kulkarni]

On 10/28/25 22:58, Randy Dunlap wrote:
> 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'
>
> Signed-off-by: Randy Dunlap<rdunlap@infradead.org>


Looks good.

Reviewed-by: Chaitanya Kulkarni <kch@nvidia.com>

-ck