Thread (4 messages) 4 messages, 4 authors, 2022-09-21

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

From: Damien Le Moal <hidden>
Date: 2022-09-20 21:54:19

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 <redacted>
Cc: Hannes Reinecke <hare@suse.de>
Cc: Damien Le Moal <redacted>
Cc: Johannes Thumshirn <redacted>
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 <redacted>
quoted hunk ↗ jump to hunk
---
  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
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help