* [PATCH] block: Fix the enum blk_eh_timer_return documentation
@ 2022-09-20 20:06 Bart Van Assche
2022-09-20 21:54 ` Damien Le Moal
` (2 more replies)
0 siblings, 3 replies; 4+ messages in thread
From: Bart Van Assche @ 2022-09-20 20:06 UTC (permalink / raw)
To: Jens Axboe
Cc: linux-block, Christoph Hellwig, Bart Van Assche, Ming Lei,
Hannes Reinecke, Damien Le Moal, Johannes Thumshirn,
Johannes Thumshirn, Hannes Reinecke
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 */
^ permalink raw reply related [flat|nested] 4+ messages in thread
* Re: [PATCH] block: Fix the enum blk_eh_timer_return documentation
2022-09-20 20:06 [PATCH] block: Fix the enum blk_eh_timer_return documentation Bart Van Assche
@ 2022-09-20 21:54 ` Damien Le Moal
2022-09-21 6:49 ` Johannes Thumshirn
2022-09-21 14:37 ` Jens Axboe
2 siblings, 0 replies; 4+ messages in thread
From: Damien Le Moal @ 2022-09-20 21:54 UTC (permalink / raw)
To: Bart Van Assche, Jens Axboe
Cc: linux-block, Christoph Hellwig, Ming Lei, Hannes Reinecke,
Damien Le Moal, Johannes Thumshirn, Johannes Thumshirn,
Hannes Reinecke
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
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH] block: Fix the enum blk_eh_timer_return documentation
2022-09-20 20:06 [PATCH] block: Fix the enum blk_eh_timer_return documentation Bart Van Assche
2022-09-20 21:54 ` Damien Le Moal
@ 2022-09-21 6:49 ` Johannes Thumshirn
2022-09-21 14:37 ` Jens Axboe
2 siblings, 0 replies; 4+ messages in thread
From: Johannes Thumshirn @ 2022-09-21 6:49 UTC (permalink / raw)
To: Bart Van Assche, Jens Axboe
Cc: linux-block, Christoph Hellwig, Ming Lei, Hannes Reinecke,
Damien Le Moal, Johannes Thumshirn, Hannes Reinecke
Looks good,
Reviewed-by: Johannes Thumshirn <johannes.thumshirn@wdc.com>
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH] block: Fix the enum blk_eh_timer_return documentation
2022-09-20 20:06 [PATCH] block: Fix the enum blk_eh_timer_return documentation Bart Van Assche
2022-09-20 21:54 ` Damien Le Moal
2022-09-21 6:49 ` Johannes Thumshirn
@ 2022-09-21 14:37 ` Jens Axboe
2 siblings, 0 replies; 4+ messages in thread
From: Jens Axboe @ 2022-09-21 14:37 UTC (permalink / raw)
To: Bart Van Assche
Cc: Damien Le Moal, linux-block, Hannes Reinecke, Ming Lei,
Hannes Reinecke, Johannes Thumshirn, Johannes Thumshirn,
Christoph Hellwig
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
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2022-09-21 14:37 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-09-20 20:06 [PATCH] block: Fix the enum blk_eh_timer_return documentation Bart Van Assche
2022-09-20 21:54 ` Damien Le Moal
2022-09-21 6:49 ` Johannes Thumshirn
2022-09-21 14:37 ` Jens Axboe
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).