From: Jonathan Corbet <corbet@lwn.net>
To: "James E.J. Bottomley" <jejb@linux.vnet.ibm.com>,
"Martin K. Petersen" <martin.petersen@oracle.com>
Cc: linux-scsi@vger.kernel.org, linux-doc@vger.kernel.org
Subject: [PATCH] scsi: Fix the kerneldoc for scsi_initialize_rq()
Date: Thu, 24 Aug 2017 16:11:09 -0600 [thread overview]
Message-ID: <20170824161109.6e23432b@lwn.net> (raw)
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.
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
---
drivers/scsi/scsi_lib.c | 1 +
1 file changed, 1 insertion(+)
diff --git a/drivers/scsi/scsi_lib.c b/drivers/scsi/scsi_lib.c
index f6097b89d5d3..a76515814ee7 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 used to locate the scsi_cmnd structure.
*
* Called from inside blk_get_request().
*/
--
2.13.4
next reply other threads:[~2017-08-24 22:11 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-08-24 22:11 Jonathan Corbet [this message]
2017-08-24 23:26 ` [PATCH] scsi: Fix the kerneldoc for scsi_initialize_rq() Bart Van Assche
2017-08-25 21:39 ` Martin K. Petersen
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20170824161109.6e23432b@lwn.net \
--to=corbet@lwn.net \
--cc=jejb@linux.vnet.ibm.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-scsi@vger.kernel.org \
--cc=martin.petersen@oracle.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox