diff mbox series

Make the scsi_init_io() documentation more accurate

Message ID 20200629160433.14390-1-bvanassche@acm.org
State New
Headers show
Series Make the scsi_init_io() documentation more accurate | expand

Commit Message

Bart Van Assche June 29, 2020, 4:04 p.m. UTC 
The current scsi_init_io() documentation does not accurately explain what
this function does. Make the scsi_init_io() documentation more accurate.

Cc: Christoph Hellwig <hch@lst.de>
Cc: Johannes Thumshirn <johannes.thumshirn@wdc.com>
Cc: Hannes Reinecke <hare@suse.de>
Cc: Daniel Wagner <dwagner@suse.de>
Signed-off-by: Bart Van Assche <bvanassche@acm.org>
---
 drivers/scsi/scsi_lib.c | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

Comments

Johannes Thumshirn June 29, 2020, 4:15 p.m. UTC | #1 
On 29/06/2020 18:04, Bart Van Assche wrote:
> + * for @cmd. Functions like scsi_sg_count(), scsi_sg_list() and scsi_bufflen()
                                  scsi_sglist() ~^ 

and I don't think that sentence should be included at all as these values are 
initialized in scsi_init_sgtable().
diff mbox series

Patch

diff --git a/drivers/scsi/scsi_lib.c b/drivers/scsi/scsi_lib.c
index 7c42c00afb0d..b2b9bbaad9fe 100644
--- a/drivers/scsi/scsi_lib.c
+++ b/drivers/scsi/scsi_lib.c
@@ -961,8 +961,12 @@  static inline bool scsi_cmd_needs_dma_drain(struct scsi_device *sdev,
 }
 
 /**
- * scsi_init_io - SCSI I/O initialization function.
- * @cmd:  command descriptor we wish to initialize
+ * scsi_init_io - Allocate and initialize data and integrity scatterlists
+ * @cmd: SCSI command data structure to initialize.
+ *
+ * Initializes @cmd->sdb and also @cmd->prot_sdb if data integrity is enabled
+ * for @cmd. Functions like scsi_sg_count(), scsi_sg_list() and scsi_bufflen()
+ * return the values stored by this function in the @cmd data structure.
  *
  * Returns:
  * * BLK_STS_OK       - on success