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)
committerMartin K. Petersen <martin.petersen@oracle.com>
Sun, 23 Jul 2023 20:35:56 +0000 (16:35 -0400)
commitf669b8a683e4ee26fa5cafe19d71cec1786b556a
tree5a7bc1916319b06c38dfa01f510af11d6b735ca0
parent0645ab15ed0bf5b17ad510bd72ef589cda542795
scsi: core: Fix the scsi_set_resid() documentation

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>
Documentation/scsi/scsi_mid_low_api.rst