2021-12-31 08:23:57

by Yang Li

[permalink] [raw]
Subject: [PATCH -next] scsi: mpi3mr: Fix formatting problems in some kernel-doc comments

Remove some warnings found by running scripts/kernel-doc,
which is caused by using 'make W=1'.
drivers/scsi/mpi3mr/mpi3mr_fw.c:2188: warning: Function parameter or
member 'reason_code' not described in 'mpi3mr_check_rh_fault_ioc'
drivers/scsi/mpi3mr/mpi3mr_fw.c:3650: warning: Excess function parameter
'init_type' description in 'mpi3mr_init_ioc'
drivers/scsi/mpi3mr/mpi3mr_fw.c:4177: warning: bad line

Signed-off-by: Yang Li <[email protected]>
---
drivers/scsi/mpi3mr/mpi3mr_fw.c | 5 ++---
1 file changed, 2 insertions(+), 3 deletions(-)

diff --git a/drivers/scsi/mpi3mr/mpi3mr_fw.c b/drivers/scsi/mpi3mr/mpi3mr_fw.c
index c39dd4978c9d..7fe714c5158b 100644
--- a/drivers/scsi/mpi3mr/mpi3mr_fw.c
+++ b/drivers/scsi/mpi3mr/mpi3mr_fw.c
@@ -2174,7 +2174,7 @@ int mpi3mr_op_request_post(struct mpi3mr_ioc *mrioc,
* mpi3mr_check_rh_fault_ioc - check reset history and fault
* controller
* @mrioc: Adapter instance reference
- * @reason_code, reason code for the fault.
+ * @reason_code: reason code for the fault.
*
* This routine will save snapdump and fault the controller with
* the given reason code if it is not already in the fault or
@@ -3633,7 +3633,6 @@ static int mpi3mr_enable_events(struct mpi3mr_ioc *mrioc)
/**
* mpi3mr_init_ioc - Initialize the controller
* @mrioc: Adapter instance reference
- * @init_type: Flag to indicate is the init_type
*
* This the controller initialization routine, executed either
* after soft reset or from pci probe callback.
@@ -4174,7 +4173,7 @@ static void mpi3mr_issue_ioc_shutdown(struct mpi3mr_ioc *mrioc)
/**
* mpi3mr_cleanup_ioc - Cleanup controller
* @mrioc: Adapter instance reference
-
+ *
* controller cleanup handler, Message unit reset or soft reset
* and shutdown notification is issued to the controller.
*
--
2.20.1.7.g153144c



2022-01-05 05:35:05

by Martin K. Petersen

[permalink] [raw]
Subject: Re: [PATCH -next] scsi: mpi3mr: Fix formatting problems in some kernel-doc comments


Yang,

> Remove some warnings found by running scripts/kernel-doc,
> which is caused by using 'make W=1'.
> drivers/scsi/mpi3mr/mpi3mr_fw.c:2188: warning: Function parameter or
> member 'reason_code' not described in 'mpi3mr_check_rh_fault_ioc'
> drivers/scsi/mpi3mr/mpi3mr_fw.c:3650: warning: Excess function parameter
> 'init_type' description in 'mpi3mr_init_ioc'
> drivers/scsi/mpi3mr/mpi3mr_fw.c:4177: warning: bad line

Applied to 5.17/scsi-staging, thanks!

--
Martin K. Petersen Oracle Linux Engineering

2022-01-10 22:05:12

by Martin K. Petersen

[permalink] [raw]
Subject: Re: [PATCH -next] scsi: mpi3mr: Fix formatting problems in some kernel-doc comments

On Fri, 31 Dec 2021 16:23:50 +0800, Yang Li wrote:

> Remove some warnings found by running scripts/kernel-doc,
> which is caused by using 'make W=1'.
> drivers/scsi/mpi3mr/mpi3mr_fw.c:2188: warning: Function parameter or
> member 'reason_code' not described in 'mpi3mr_check_rh_fault_ioc'
> drivers/scsi/mpi3mr/mpi3mr_fw.c:3650: warning: Excess function parameter
> 'init_type' description in 'mpi3mr_init_ioc'
> drivers/scsi/mpi3mr/mpi3mr_fw.c:4177: warning: bad line
>
> [...]

Applied to 5.17/scsi-queue, thanks!

[1/1] scsi: mpi3mr: Fix formatting problems in some kernel-doc comments
https://git.kernel.org/mkp/scsi/c/3bb3c24e268a

--
Martin K. Petersen Oracle Linux Engineering