block: Fix kernel-doc warnings reported when building with W=1
authorBart Van Assche <bart.vanassche@wdc.com>
Tue, 9 Jan 2018 18:11:00 +0000 (10:11 -0800)
committerJens Axboe <axboe@kernel.dk>
Tue, 9 Jan 2018 18:15:17 +0000 (11:15 -0700)
Commit 3a025e1d1c2e ("Add optional check for bad kernel-doc comments")
causes W=1 the kernel-doc script to be run and thereby causes several
new warnings to appear when building the kernel with W=1. Fix the
block layer kernel-doc headers such that the block layer again builds
cleanly with W=1.

Signed-off-by: Bart Van Assche <bart.vanassche@wdc.com>
Cc: Martin K. Petersen <martin.petersen@oracle.com>
Cc: Christoph Hellwig <hch@lst.de>
Cc: Hannes Reinecke <hare@suse.de>
Cc: Johannes Thumshirn <jthumshirn@suse.de>
Signed-off-by: Jens Axboe <axboe@kernel.dk>
block/bsg-lib.c
block/scsi_ioctl.c

index 15d25ccd51a5cad7c9505427888f88c15a9e5d99..1474153f73e3e657055001502f39d51bf00e989f 100644 (file)
@@ -30,7 +30,7 @@
 
 /**
  * bsg_teardown_job - routine to teardown a bsg job
- * @job: bsg_job that is to be torn down
+ * @kref: kref inside bsg_job that is to be torn down
  */
 static void bsg_teardown_job(struct kref *kref)
 {
@@ -251,6 +251,7 @@ static void bsg_exit_rq(struct request_queue *q, struct request *req)
  * @name: device to give bsg device
  * @job_fn: bsg job handler
  * @dd_job_size: size of LLD data needed for each job
+ * @release: @dev release function
  */
 struct request_queue *bsg_setup_queue(struct device *dev, const char *name,
                bsg_job_fn *job_fn, int dd_job_size,
index edcfff974527796a9432b0c262f3961a70e4c2d7..5cddff44a2f830ccc96c48826dac21ac28fcb6dc 100644 (file)
@@ -384,9 +384,10 @@ out_put_request:
 
 /**
  * sg_scsi_ioctl  --  handle deprecated SCSI_IOCTL_SEND_COMMAND ioctl
- * @file:      file this ioctl operates on (optional)
  * @q:         request queue to send scsi commands down
  * @disk:      gendisk to operate on (option)
+ * @mode:      mode used to open the file through which the ioctl has been
+ *             submitted
  * @sic:       userspace structure describing the command to perform
  *
  * Send down the scsi command described by @sic to the device below
@@ -415,10 +416,10 @@ out_put_request:
  *      Positive numbers returned are the compacted SCSI error codes (4
  *      bytes in one int) where the lowest byte is the SCSI status.
  */
-#define OMAX_SB_LEN 16          /* For backward compatibility */
 int sg_scsi_ioctl(struct request_queue *q, struct gendisk *disk, fmode_t mode,
                struct scsi_ioctl_command __user *sic)
 {
+       enum { OMAX_SB_LEN = 16 };      /* For backward compatibility */
        struct request *rq;
        struct scsi_request *req;
        int err;