diff mbox series

[-next] scsi: pmcraid: Fix some kernel-doc comments

Message ID 20231017025853.67562-1-yang.lee@linux.alibaba.com (mailing list archive)
State Accepted
Headers show
Series [-next] scsi: pmcraid: Fix some kernel-doc comments | expand

Commit Message

Yang Li Oct. 17, 2023, 2:58 a.m. UTC
Fix some kernel-doc comments to silence the warnings:
drivers/scsi/pmcraid.c:2697: warning: Excess function parameter 'scsi_cmd' description in 'pmcraid_reset_device'
drivers/scsi/pmcraid.c:2697: warning: Function parameter or member 'scsi_dev' not described in 'pmcraid_reset_device'

Reported-by: Abaci Robot <abaci@linux.alibaba.com>
Closes: https://bugzilla.openanolis.cn/show_bug.cgi?id=6843
Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
---
 drivers/scsi/pmcraid.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Martin K. Petersen Oct. 25, 2023, 2:22 a.m. UTC | #1
Yang,

> Fix some kernel-doc comments to silence the warnings:
> drivers/scsi/pmcraid.c:2697: warning: Excess function parameter 'scsi_cmd' description in 'pmcraid_reset_device'
> drivers/scsi/pmcraid.c:2697: warning: Function parameter or member
> 'scsi_dev' not described in 'pmcraid_reset_device'

Applied to 6.7/scsi-staging, thanks!
Martin K. Petersen Oct. 30, 2023, 3:34 p.m. UTC | #2
On Tue, 17 Oct 2023 10:58:53 +0800, Yang Li wrote:

> Fix some kernel-doc comments to silence the warnings:
> drivers/scsi/pmcraid.c:2697: warning: Excess function parameter 'scsi_cmd' description in 'pmcraid_reset_device'
> drivers/scsi/pmcraid.c:2697: warning: Function parameter or member 'scsi_dev' not described in 'pmcraid_reset_device'
> 
> 

Applied to 6.7/scsi-queue, thanks!

[1/1] scsi: pmcraid: Fix some kernel-doc comments
      https://git.kernel.org/mkp/scsi/c/9e1c911ecbbc
diff mbox series

Patch

diff --git a/drivers/scsi/pmcraid.c b/drivers/scsi/pmcraid.c
index a831b34c08a4..af970cee53c9 100644
--- a/drivers/scsi/pmcraid.c
+++ b/drivers/scsi/pmcraid.c
@@ -2679,7 +2679,7 @@  static int pmcraid_error_handler(struct pmcraid_cmd *cmd)
 /**
  * pmcraid_reset_device - device reset handler functions
  *
- * @scsi_cmd: scsi command struct
+ * @scsi_dev: scsi device struct
  * @timeout: command timeout
  * @modifier: reset modifier indicating the reset sequence to be performed
  *