Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

block: Fix the enum blk_eh_timer_return documentation

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>
Reviewed-by: Johannes Thumshirn <johannes.thumshirn@wdc.com>
Reviewed-by: Damien Le Moal <damien.lemoal@opensource.wdc.com>
Link: https://lore.kernel.org/r/20220920200626.3422296-1-bvanassche@acm.org
Signed-off-by: Jens Axboe <axboe@kernel.dk>

authored by

Bart Van Assche and committed by
Jens Axboe
b2bed51a 32ff8ce0

+9 -2
+9 -2
include/linux/blk-mq.h
··· 268 268 rq_list_add(dst, rq); 269 269 } 270 270 271 + /** 272 + * enum blk_eh_timer_return - How the timeout handler should proceed 273 + * @BLK_EH_DONE: The block driver completed the command or will complete it at 274 + * a later time. 275 + * @BLK_EH_RESET_TIMER: Reset the request timer and continue waiting for the 276 + * request to complete. 277 + */ 271 278 enum blk_eh_timer_return { 272 - BLK_EH_DONE, /* drivers has completed the command */ 273 - BLK_EH_RESET_TIMER, /* reset timer and try again */ 279 + BLK_EH_DONE, 280 + BLK_EH_RESET_TIMER, 274 281 }; 275 282 276 283 #define BLK_TAG_ALLOC_FIFO 0 /* allocate starting from 0 */