[PATCH] scsi: mpi3mr: fix mpi3mr_fw.c kernel-doc warnings

[PATCH] scsi: mpi3mr: fix mpi3mr_fw.c kernel-doc warnings

[Randy Dunlap]

Use correct format for function return values.
Delete blank lines that are reported as "bad line:".

mpi3mr_fw.c:482: warning: No description found for return value of 'mpi3mr_get_reply_desc'
mpi3mr_fw.c:1066: warning: bad line: 
mpi3mr_fw.c:1109: warning: bad line: 
mpi3mr_fw.c:1249: warning: No description found for return value of 'mpi3mr_revalidate_factsdata'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Sathya Prakash Veerichetty <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: mpi3mr-linuxdrv.pdl@broadcom.com
Cc: "James E.J. Bottomley" <jejb@linux.ibm.com>
Cc: "Martin K. Petersen" <martin.petersen@oracle.com>
Cc: linux-scsi@vger.kernel.org
---
 drivers/scsi/mpi3mr/mpi3mr_fw.c |    6 ++----
 1 file changed, 2 insertions(+), 4 deletions(-)

diff -- a/drivers/scsi/mpi3mr/mpi3mr_fw.c b/drivers/scsi/mpi3mr/mpi3mr_fw.c
--- a/drivers/scsi/mpi3mr/mpi3mr_fw.c
+++ b/drivers/scsi/mpi3mr/mpi3mr_fw.c
@@ -475,7 +475,7 @@ int mpi3mr_process_admin_reply_q(struct
  * @op_reply_q: op_reply_qinfo object
  * @reply_ci: operational reply descriptor's queue consumer index
  *
- * Returns reply descriptor frame address
+ * Returns: reply descriptor frame address
  */
 static inline struct mpi3_default_reply_descriptor *
 mpi3mr_get_reply_desc(struct op_reply_qinfo *op_reply_q, u32 reply_ci)
@@ -1063,7 +1063,6 @@ enum mpi3mr_iocstate mpi3mr_get_iocstate
  * @mrioc: Adapter instance reference
  *
  * Free the DMA memory allocated for IOCTL handling purpose.
-
  *
  * Return: None
  */
@@ -1106,7 +1105,6 @@ static void mpi3mr_free_ioctl_dma_memory
 /**
  * mpi3mr_alloc_ioctl_dma_memory - Alloc memory for ioctl dma
  * @mrioc: Adapter instance reference
-
  *
  * This function allocates dmaable memory required to handle the
  * application issued MPI3 IOCTL requests.
@@ -1241,7 +1239,7 @@ static int mpi3mr_issue_and_process_mur(
  * during reset/resume
  * @mrioc: Adapter instance reference
  *
- * Return zero if the new IOCFacts parameters value is compatible with
+ * Return: zero if the new IOCFacts parameters value is compatible with
  * older values else return -EPERM
  */
 static int

Re: [PATCH] scsi: mpi3mr: fix mpi3mr_fw.c kernel-doc warnings

[Martin K. Petersen]

Randy,

> Use correct format for function return values.
> Delete blank lines that are reported as "bad line:".

Applied to 6.8/scsi-staging, thanks!

-- 
Martin K. Petersen	Oracle Linux Engineering

Re: [PATCH] scsi: mpi3mr: fix mpi3mr_fw.c kernel-doc warnings

[Martin K. Petersen]

On Wed, 20 Dec 2023 21:31:13 -0800, Randy Dunlap wrote:

> Use correct format for function return values.
> Delete blank lines that are reported as "bad line:".
> 
> mpi3mr_fw.c:482: warning: No description found for return value of 'mpi3mr_get_reply_desc'
> mpi3mr_fw.c:1066: warning: bad line:
> mpi3mr_fw.c:1109: warning: bad line:
> mpi3mr_fw.c:1249: warning: No description found for return value of 'mpi3mr_revalidate_factsdata'
> 
> [...]

Applied to 6.8/scsi-queue, thanks!

[1/1] scsi: mpi3mr: fix mpi3mr_fw.c kernel-doc warnings
      https://git.kernel.org/mkp/scsi/c/904fdd2062f3

-- 
Martin K. Petersen	Oracle Linux Engineering