scsi: cxlflash: Fix a little doc-rot
authorLee Jones <lee.jones@linaro.org>
Wed, 17 Mar 2021 09:12:25 +0000 (09:12 +0000)
committerMartin K. Petersen <martin.petersen@oracle.com>
Fri, 19 Mar 2021 03:41:08 +0000 (23:41 -0400)
Fixes the following W=1 kernel build warning(s):

 drivers/scsi/cxlflash/main.c:1369: warning: Function parameter or member 'hwq' not described in 'process_hrrq'
 drivers/scsi/cxlflash/main.c:1369: warning: Excess function parameter 'afu' description in 'process_hrrq'
 drivers/scsi/cxlflash/main.c:2005: warning: Function parameter or member 'index' not described in 'init_mc'
 drivers/scsi/cxlflash/main.c:3303: warning: Function parameter or member 'lunprov' not described in 'cxlflash_lun_provision'
 drivers/scsi/cxlflash/main.c:3303: warning: Excess function parameter 'arg' description in 'cxlflash_lun_provision'
 drivers/scsi/cxlflash/main.c:3397: warning: Function parameter or member 'afu_dbg' not described in 'cxlflash_afu_debug'
 drivers/scsi/cxlflash/main.c:3397: warning: Excess function parameter 'arg' description in 'cxlflash_afu_debug'

Link: https://lore.kernel.org/r/20210317091230.2912389-32-lee.jones@linaro.org
Cc: "Manoj N. Kumar" <manoj@linux.ibm.com>
Cc: "Matthew R. Ochs" <mrochs@linux.ibm.com>
Cc: Uma Krishnan <ukrishn@linux.ibm.com>
Cc: "James E.J. Bottomley" <jejb@linux.ibm.com>
Cc: "Martin K. Petersen" <martin.petersen@oracle.com>
Cc: linux-scsi@vger.kernel.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
Signed-off-by: Martin K. Petersen <martin.petersen@oracle.com>
drivers/scsi/cxlflash/main.c

index e72440d..dc36531 100644 (file)
@@ -1357,7 +1357,7 @@ cxlflash_sync_err_irq_exit:
 
 /**
  * process_hrrq() - process the read-response queue
- * @afu:       AFU associated with the host.
+ * @hwq:       HWQ associated with the host.
  * @doneq:     Queue of commands harvested from the RRQ.
  * @budget:    Threshold of RRQ entries to process.
  *
@@ -1997,7 +1997,7 @@ out:
 /**
  * init_mc() - create and register as the master context
  * @cfg:       Internal structure associated with the host.
- * index:      HWQ Index of the master context.
+ * @index:     HWQ Index of the master context.
  *
  * Return: 0 on success, -errno on failure
  */
@@ -3294,7 +3294,7 @@ static char *decode_hioctl(unsigned int cmd)
 /**
  * cxlflash_lun_provision() - host LUN provisioning handler
  * @cfg:       Internal structure associated with the host.
- * @arg:       Kernel copy of userspace ioctl data structure.
+ * @lunprov:   Kernel copy of userspace ioctl data structure.
  *
  * Return: 0 on success, -errno on failure
  */
@@ -3385,7 +3385,7 @@ out:
 /**
  * cxlflash_afu_debug() - host AFU debug handler
  * @cfg:       Internal structure associated with the host.
- * @arg:       Kernel copy of userspace ioctl data structure.
+ * @afu_dbg:   Kernel copy of userspace ioctl data structure.
  *
  * For debug requests requiring a data buffer, always provide an aligned
  * (cache line) buffer to the AFU to appease any alignment requirements.