[PATCH] block: Fix the enum blk_eh_timer_return documentation

[PATCH] block: Fix the enum blk_eh_timer_return documentation

[Bart Van Assche]

The documentation of the blk_eh_timer_return enumeration values does not
reflect correctly how e.g. the SCSI core uses these values. Fix the
documentation.

Cc: Christoph Hellwig <hch@lst.de>
Cc: Ming Lei <ming.lei@redhat.com>
Cc: Hannes Reinecke <hare@suse.de>
Cc: Damien Le Moal <damien.lemoal@wdc.com>
Cc: Johannes Thumshirn <johannes.thumshirn@wdc.com>
Fixes: 88b0cfad2888 ("block: document the blk_eh_timer_return values")
Signed-off-by: Bart Van Assche <bvanassche@acm.org>
---
 include/linux/blk-mq.h | 11 +++++++++--
 1 file changed, 9 insertions(+), 2 deletions(-)

diff --git a/include/linux/blk-mq.h b/include/linux/blk-mq.h
index 92294a5fb083..1532cd07a597 100644
--- a/include/linux/blk-mq.h
+++ b/include/linux/blk-mq.h
@@ -268,9 +268,16 @@ static inline void rq_list_move(struct request **src, struct request **dst,
 	rq_list_add(dst, rq);
 }
 
+/**
+ * enum blk_eh_timer_return - How the timeout handler should proceed
+ * @BLK_EH_DONE: The block driver completed the command or will complete it at
+ *	a later time.
+ * @BLK_EH_RESET_TIMER: Reset the request timer and continue waiting for the
+ *	request to complete.
+ */
 enum blk_eh_timer_return {
-	BLK_EH_DONE,		/* drivers has completed the command */
-	BLK_EH_RESET_TIMER,	/* reset timer and try again */
+	BLK_EH_DONE,
+	BLK_EH_RESET_TIMER,
 };
 
 #define BLK_TAG_ALLOC_FIFO 0 /* allocate starting from 0 */

Re: [PATCH] block: Fix the enum blk_eh_timer_return documentation

[Damien Le Moal]

On 9/21/22 05:06, Bart Van Assche wrote:
> The documentation of the blk_eh_timer_return enumeration values does not
> reflect correctly how e.g. the SCSI core uses these values. Fix the
> documentation.
> 
> Cc: Christoph Hellwig <hch@lst.de>
> Cc: Ming Lei <ming.lei@redhat.com>
> Cc: Hannes Reinecke <hare@suse.de>
> Cc: Damien Le Moal <damien.lemoal@wdc.com>
> Cc: Johannes Thumshirn <johannes.thumshirn@wdc.com>
> Fixes: 88b0cfad2888 ("block: document the blk_eh_timer_return values")
> Signed-off-by: Bart Van Assche <bvanassche@acm.org>

Looks OK to me.

Reviewed-by: Damien Le Moal <damien.lemoal@opensource.wdc.com>

> ---
>   include/linux/blk-mq.h | 11 +++++++++--
>   1 file changed, 9 insertions(+), 2 deletions(-)
> 
> diff --git a/include/linux/blk-mq.h b/include/linux/blk-mq.h
> index 92294a5fb083..1532cd07a597 100644
> --- a/include/linux/blk-mq.h
> +++ b/include/linux/blk-mq.h
> @@ -268,9 +268,16 @@ static inline void rq_list_move(struct request **src, struct request **dst,
>   	rq_list_add(dst, rq);
>   }
>   
> +/**
> + * enum blk_eh_timer_return - How the timeout handler should proceed
> + * @BLK_EH_DONE: The block driver completed the command or will complete it at
> + *	a later time.
> + * @BLK_EH_RESET_TIMER: Reset the request timer and continue waiting for the
> + *	request to complete.
> + */
>   enum blk_eh_timer_return {
> -	BLK_EH_DONE,		/* drivers has completed the command */
> -	BLK_EH_RESET_TIMER,	/* reset timer and try again */
> +	BLK_EH_DONE,
> +	BLK_EH_RESET_TIMER,
>   };
>   
>   #define BLK_TAG_ALLOC_FIFO 0 /* allocate starting from 0 */

-- 
Damien Le Moal
Western Digital Research

Re: [PATCH] block: Fix the enum blk_eh_timer_return documentation

[Johannes Thumshirn]

Looks good,
Reviewed-by: Johannes Thumshirn <johannes.thumshirn@wdc.com>

Re: [PATCH] block: Fix the enum blk_eh_timer_return documentation

[Jens Axboe]

On Tue, 20 Sep 2022 13:06:26 -0700, Bart Van Assche wrote:
> The documentation of the blk_eh_timer_return enumeration values does not
> reflect correctly how e.g. the SCSI core uses these values. Fix the
> documentation.
> 
> 

Applied, thanks!

[1/1] block: Fix the enum blk_eh_timer_return documentation
      commit: b2bed51a5261f4266ecb857bba680a7f668d3ddf

Best regards,
-- 
Jens Axboe