On Mon, Feb 17, 2020 at 01:08:35PM -0800, Bart Van Assche wrote:
> The 'hctx_list' member of struct blk_mq_hw_ctx is not a list head but
> instead an entry in q->unused_hctx_list. Fix the comment above this
> struct member.
>
> Cc: André Almeida <andrealmeid@xxxxxxxxxxxxx>
> Fixes: d386732bc142 ("blk-mq: fill header with kernel-doc")
> Signed-off-by: Bart Van Assche <bvanassche@xxxxxxx>
> ---
> include/linux/blk-mq.h | 5 ++++-
> 1 file changed, 4 insertions(+), 1 deletion(-)
>
> diff --git a/include/linux/blk-mq.h b/include/linux/blk-mq.h
> index 11cfd6470b1a..31344d5f83e2 100644
> --- a/include/linux/blk-mq.h
> +++ b/include/linux/blk-mq.h
> @@ -162,7 +162,10 @@ struct blk_mq_hw_ctx {
> struct dentry *sched_debugfs_dir;
> #endif
>
> - /** @hctx_list: List of all hardware queues. */
> + /**
> + * @hctx_list: if this hctx is not in use, this is an entry in
> + * q->unused_hctx_list.
> + */
> struct list_head hctx_list;
The patch itself is correct, however, we may rename the field as
'unused_node' or whatever so that it can be self-documented.
Thanks,
Ming
