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

Yang Li posted 1 patch 2 years, 2 months ago
drivers/scsi/pmcraid.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
[PATCH -next] scsi: pmcraid: Fix some kernel-doc comments
Posted by Yang Li 2 years, 2 months ago
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(-)

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
  *
-- 
2.20.1.7.g153144c
Re: [PATCH -next] scsi: pmcraid: Fix some kernel-doc comments
Posted by Martin K. Petersen 2 years, 1 month ago
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

-- 
Martin K. Petersen	Oracle Linux Engineering
Re: [PATCH -next] scsi: pmcraid: Fix some kernel-doc comments
Posted by Martin K. Petersen 2 years, 1 month ago
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	Oracle Linux Engineering