[PATCH v2] scsi: mpi3mr: fix kernel-doc issues in mpi3mr_app.c

[PATCH v2] scsi: mpi3mr: fix kernel-doc issues in mpi3mr_app.c

[Randy Dunlap]

Fix all kernel-doc problems in mpi3mr_app.c:

mpi3mr_app.c:809: warning: Excess function parameter 'data' description in 'mpi3mr_set_trigger_data_in_hdb'
mpi3mr_app.c:836: warning: Excess function parameter 'data' description in 'mpi3mr_set_trigger_data_in_all_hdb'
mpi3mr_app.c:3395: warning: No description found for return value of 'sas_ncq_prio_supported_show'
mpi3mr_app.c:3413: warning: No description found for return value of 'sas_ncq_prio_enable_show'

Fixes: fc4444941140 ("scsi: mpi3mr: HDB allocation and posting for hardware and firmware buffers")
Fixes: d8d08d1638ce ("scsi: mpi3mr: Trigger support")
Fixes: 90e6f08915ec ("scsi: mpi3mr: Fix ATA NCQ priority support")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Reviewed-by: Damien Le Moal <dlemoal@kernel.org>
Cc: Sathya Prakash <sathya.prakash@broadcom.com>
Cc: Kashyap Desai <kashyap.desai@broadcom.com>
Cc: Sumit Saxena <sumit.saxena@broadcom.com>
Cc: Sreekanth Reddy <sreekanth.reddy@broadcom.com>
Cc: Ranjan Kumar <ranjan.kumar@broadcom.com>
Cc: mpi3mr-linuxdrv.pdl@broadcom.com
Cc: Damien Le Moal <dlemoal@kernel.org>
Cc: "James E.J. Bottomley" <James.Bottomley@HansenPartnership.com>
Cc: "Martin K. Petersen" <martin.petersen@oracle.com>
---
v2: add hash and enclose commit title in ("...") for fc4444941140.
    add Damien's Reviewed-by: tag.
    (Thanks, Damien.)

 drivers/scsi/mpi3mr/mpi3mr_app.c |   10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

--- lnx-616-rc2.orig/drivers/scsi/mpi3mr/mpi3mr_app.c
+++ lnx-616-rc2/drivers/scsi/mpi3mr/mpi3mr_app.c
@@ -795,9 +795,8 @@ void mpi3mr_release_diag_bufs(struct mpi
  *
  * @hdb: HDB pointer
  * @type: Trigger type
- * @data: Trigger data
- * @force: Trigger overwrite flag
  * @trigger_data: Pointer to trigger data information
+ * @force: Trigger overwrite flag
  *
  * Updates trigger type and trigger data based on parameter
  * passed to this function
@@ -822,9 +821,8 @@ void mpi3mr_set_trigger_data_in_hdb(stru
  *
  * @mrioc: Adapter instance reference
  * @type: Trigger type
- * @data: Trigger data
- * @force: Trigger overwrite flag
  * @trigger_data: Pointer to trigger data information
+ * @force: Trigger overwrite flag
  *
  * Updates trigger type and trigger data based on parameter
  * passed to this function
@@ -3388,6 +3386,8 @@ static DEVICE_ATTR_RO(persistent_id);
  * @buf: the buffer returned
  *
  * A sysfs 'read-only' sdev attribute, only works with SATA devices
+ *
+ * Returns: the number of characters written to @buf
  */
 static ssize_t
 sas_ncq_prio_supported_show(struct device *dev,
@@ -3406,6 +3406,8 @@ static DEVICE_ATTR_RO(sas_ncq_prio_suppo
  * @buf: the buffer returned
  *
  * A sysfs 'read/write' sdev attribute, only works with SATA devices
+ *
+ * Returns: the number of characters written to @buf
  */
 static ssize_t
 sas_ncq_prio_enable_show(struct device *dev,

Re: [PATCH v2] scsi: mpi3mr: fix kernel-doc issues in mpi3mr_app.c

[Martin K. Petersen]

Randy,

> Fix all kernel-doc problems in mpi3mr_app.c:

Applied to 6.17/scsi-staging, thanks!

-- 
Martin K. Petersen

Re: [PATCH v2] scsi: mpi3mr: fix kernel-doc issues in mpi3mr_app.c

[Martin K. Petersen]

On Fri, 20 Jun 2025 09:21:58 -0700, Randy Dunlap wrote:

> Fix all kernel-doc problems in mpi3mr_app.c:
> 
> mpi3mr_app.c:809: warning: Excess function parameter 'data' description in 'mpi3mr_set_trigger_data_in_hdb'
> mpi3mr_app.c:836: warning: Excess function parameter 'data' description in 'mpi3mr_set_trigger_data_in_all_hdb'
> mpi3mr_app.c:3395: warning: No description found for return value of 'sas_ncq_prio_supported_show'
> mpi3mr_app.c:3413: warning: No description found for return value of 'sas_ncq_prio_enable_show'
> 
> [...]

Applied to 6.17/scsi-queue, thanks!

[1/1] scsi: mpi3mr: fix kernel-doc issues in mpi3mr_app.c
      https://git.kernel.org/mkp/scsi/c/ed575d4bca6a

-- 
Martin K. Petersen	Oracle Linux Engineering