diff mbox series

[v2,01/19] scsi: Fix the documentation of the scsi_execute() time parameter

Message ID 20210709202638.9480-3-bvanassche@acm.org
State New
Headers show
Series [v2,01/19] scsi: Fix the documentation of the scsi_execute() time parameter | expand

Commit Message

Bart Van Assche July 9, 2021, 8:26 p.m. UTC
The unit of the scsi_execute() timeout parameter is 1/HZ seconds instead of
one second, just like the timeouts used in the block layer. Fix the
documentation header above the definition of the scsi_execute() macro.

Reviewed-by: Avri Altman <avri.altman@wdc.com>
Cc: "James E.J. Bottomley" <jejb@linux.ibm.com>
Cc: Hannes Reinecke <hare@suse.de>
Cc: Ming Lei <ming.lei@redhat.com>
Cc: John Garry <john.garry@huawei.com>
Fixes: "[SCSI] use scatter lists for all block pc requests and simplify hw handlers" # v2.6.16.28
Signed-off-by: Bart Van Assche <bvanassche@acm.org>
---
 drivers/scsi/scsi_lib.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Hannes Reinecke July 10, 2021, 8:17 a.m. UTC | #1
On 7/9/21 10:26 PM, Bart Van Assche wrote:
> The unit of the scsi_execute() timeout parameter is 1/HZ seconds instead of

> one second, just like the timeouts used in the block layer. Fix the

> documentation header above the definition of the scsi_execute() macro.

> 

> Reviewed-by: Avri Altman <avri.altman@wdc.com>

> Cc: "James E.J. Bottomley" <jejb@linux.ibm.com>

> Cc: Hannes Reinecke <hare@suse.de>

> Cc: Ming Lei <ming.lei@redhat.com>

> Cc: John Garry <john.garry@huawei.com>

> Fixes: "[SCSI] use scatter lists for all block pc requests and simplify hw handlers" # v2.6.16.28

> Signed-off-by: Bart Van Assche <bvanassche@acm.org>

> ---

>   drivers/scsi/scsi_lib.c | 2 +-

>   1 file changed, 1 insertion(+), 1 deletion(-)

> 

> diff --git a/drivers/scsi/scsi_lib.c b/drivers/scsi/scsi_lib.c

> index 7184f93dfe15..4b56e06faa5e 100644

> --- a/drivers/scsi/scsi_lib.c

> +++ b/drivers/scsi/scsi_lib.c

> @@ -194,7 +194,7 @@ void scsi_queue_insert(struct scsi_cmnd *cmd, int reason)

>    * @bufflen:	len of buffer

>    * @sense:	optional sense buffer

>    * @sshdr:	optional decoded sense header

> - * @timeout:	request timeout in seconds

> + * @timeout:	request timeout in HZ

>    * @retries:	number of times to retry request

>    * @flags:	flags for ->cmd_flags

>    * @rq_flags:	flags for ->rq_flags

> 

Reviewed-by: Hannes Reinecke <hare@suse.de>


Cheers,

Hannes
-- 
Dr. Hannes Reinecke                Kernel Storage Architect
hare@suse.de                              +49 911 74053 688
SUSE Software Solutions GmbH, Maxfeldstr. 5, 90409 Nürnberg
HRB 36809 (AG Nürnberg), Geschäftsführer: Felix Imendörffer
Martin K. Petersen July 13, 2021, 1:40 a.m. UTC | #2
Bart,

> The unit of the scsi_execute() timeout parameter is 1/HZ seconds

> instead of one second, just like the timeouts used in the block

> layer. Fix the documentation header above the definition of the

> scsi_execute() macro.


Applied to 5.14/scsi-fixes, thanks!

-- 
Martin K. Petersen	Oracle Linux Engineering
diff mbox series

Patch

diff --git a/drivers/scsi/scsi_lib.c b/drivers/scsi/scsi_lib.c
index 7184f93dfe15..4b56e06faa5e 100644
--- a/drivers/scsi/scsi_lib.c
+++ b/drivers/scsi/scsi_lib.c
@@ -194,7 +194,7 @@  void scsi_queue_insert(struct scsi_cmnd *cmd, int reason)
  * @bufflen:	len of buffer
  * @sense:	optional sense buffer
  * @sshdr:	optional decoded sense header
- * @timeout:	request timeout in seconds
+ * @timeout:	request timeout in HZ
  * @retries:	number of times to retry request
  * @flags:	flags for ->cmd_flags
  * @rq_flags:	flags for ->rq_flags