scsi: Fix the kerneldoc for scsi_initialize_rq()
authorJonathan Corbet <corbet@lwn.net>
Thu, 24 Aug 2017 22:11:09 +0000 (16:11 -0600)
committerMartin K. Petersen <martin.petersen@oracle.com>
Fri, 25 Aug 2017 21:38:40 +0000 (17:38 -0400)
The kerneldoc comment for scsi_initialize_rq() neglected to document the
"rq" parameter, leading to this docs build warning:

  ./drivers/scsi/scsi_lib.c:1116: warning: No description found for parameter 'rq'

Document the parameter and make the build slightly quieter.

[mkp: used wording suggested by Bart]

Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: Martin K. Petersen <martin.petersen@oracle.com>
drivers/scsi/scsi_lib.c

index 76adec7..696d2ea 100644 (file)
@@ -1108,6 +1108,7 @@ EXPORT_SYMBOL(scsi_init_io);
 
 /**
  * scsi_initialize_rq - initialize struct scsi_cmnd.req
+ * @rq: Request associated with the SCSI command to be initialized.
  *
  * Called from inside blk_get_request().
  */