From: Jonathan Corbet <corbet@lwn.net>
Date: Thu, 24 Aug 2017 22:11:09 +0000 (-0600)
Subject: scsi: Fix the kerneldoc for scsi_initialize_rq()
X-Git-Tag: v4.14-rc1~41^2~27
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=35c0506f27f6e3f278592d631901163cbccce28d;p=platform%2Fkernel%2Flinux-exynos.git

scsi: Fix the kerneldoc for scsi_initialize_rq()

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>
---

diff --git a/drivers/scsi/scsi_lib.c b/drivers/scsi/scsi_lib.c
index 76adec7..696d2eae 100644
--- a/drivers/scsi/scsi_lib.c
+++ b/drivers/scsi/scsi_lib.c
@@ -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().
  */