]> git.hungrycats.org Git - linux/commit
scsi: core: Fix the scsi_set_resid() documentation
authorBart Van Assche <bvanassche@acm.org>
Fri, 21 Jul 2023 16:01:32 +0000 (09:01 -0700)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Wed, 13 Sep 2023 07:48:38 +0000 (09:48 +0200)
commitd41edcef2c92d74153f80a6025bfed0892625a24
treeaa16733ca1c0a4317ddc769e934f279d82135b85
parent4329b63ce53f016f9d5e5d0925194c9fbb640502
scsi: core: Fix the scsi_set_resid() documentation

commit f669b8a683e4ee26fa5cafe19d71cec1786b556a upstream.

Because scsi_finish_command() subtracts the residual from the buffer
length, residual overflows must not be reported. Reflect this in the SCSI
documentation. See also commit 9237f04e12cc ("scsi: core: Fix
scsi_get/set_resid() interface")

Cc: Damien Le Moal <dlemoal@kernel.org>
Cc: Hannes Reinecke <hare@suse.de>
Cc: Douglas Gilbert <dgilbert@interlog.com>
Cc: stable@vger.kernel.org
Signed-off-by: Bart Van Assche <bvanassche@acm.org>
Link: https://lore.kernel.org/r/20230721160154.874010-2-bvanassche@acm.org
Signed-off-by: Martin K. Petersen <martin.petersen@oracle.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Documentation/scsi/scsi_mid_low_api.rst