[PATCH -next] scsi: target: core: Fix one kernel-doc comment

Yang Li posted 1 patch 2 years, 2 months ago
drivers/target/target_core_transport.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
[PATCH -next] scsi: target: core: Fix one kernel-doc comment
Posted by Yang Li 2 years, 2 months ago
Fix one kernel-doc comment to silence the warnings:
drivers/target/target_core_transport.c:1930: warning: Excess function parameter 'cmd' description in 'target_submit'
drivers/target/target_core_transport.c:1930: warning: Function parameter or member 'se_cmd' not described in 'target_submit'

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

diff --git a/drivers/target/target_core_transport.c b/drivers/target/target_core_transport.c
index c81def3c96df..670cfb7bd426 100644
--- a/drivers/target/target_core_transport.c
+++ b/drivers/target/target_core_transport.c
@@ -1921,7 +1921,7 @@ static void target_queue_submission(struct se_cmd *se_cmd)
 
 /**
  * target_submit - perform final initialization and submit cmd to LIO core
- * @cmd: command descriptor to submit
+ * @se_cmd: command descriptor to submit
  *
  * target_submit_prep or something similar must have been called on the cmd,
  * and this must be called from process context.
-- 
2.20.1.7.g153144c
Re: [PATCH -next] scsi: target: core: Fix one kernel-doc comment
Posted by Martin K. Petersen 2 years, 1 month ago
On Tue, 17 Oct 2023 11:09:13 +0800, Yang Li wrote:

> Fix one kernel-doc comment to silence the warnings:
> drivers/target/target_core_transport.c:1930: warning: Excess function parameter 'cmd' description in 'target_submit'
> drivers/target/target_core_transport.c:1930: warning: Function parameter or member 'se_cmd' not described in 'target_submit'
> 
> 

Applied to 6.7/scsi-queue, thanks!

[1/1] scsi: target: core: Fix one kernel-doc comment
      https://git.kernel.org/mkp/scsi/c/96f41cddbc7b

-- 
Martin K. Petersen	Oracle Linux Engineering
Re: [PATCH -next] scsi: target: core: Fix one kernel-doc comment
Posted by Martin K. Petersen 2 years, 1 month ago
Yang,

> Fix one kernel-doc comment to silence the warnings:
> drivers/target/target_core_transport.c:1930: warning: Excess function
> parameter 'cmd' description in 'target_submit'
> drivers/target/target_core_transport.c:1930: warning: Function
> parameter or member 'se_cmd' not described in 'target_submit'

Applied to 6.7/scsi-staging, thanks!

-- 
Martin K. Petersen	Oracle Linux Engineering
Re: [PATCH -next] scsi: target: core: Fix one kernel-doc comment
Posted by Mike Christie 2 years, 2 months ago
On 10/16/23 10:09 PM, Yang Li wrote:
> Fix one kernel-doc comment to silence the warnings:
> drivers/target/target_core_transport.c:1930: warning: Excess function parameter 'cmd' description in 'target_submit'
> drivers/target/target_core_transport.c:1930: warning: Function parameter or member 'se_cmd' not described in 'target_submit'
> 
> Reported-by: Abaci Robot <abaci@linux.alibaba.com>
> Closes: https://bugzilla.openanolis.cn/show_bug.cgi?id=6844
> Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
> ---
>  drivers/target/target_core_transport.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/drivers/target/target_core_transport.c b/drivers/target/target_core_transport.c
> index c81def3c96df..670cfb7bd426 100644
> --- a/drivers/target/target_core_transport.c
> +++ b/drivers/target/target_core_transport.c
> @@ -1921,7 +1921,7 @@ static void target_queue_submission(struct se_cmd *se_cmd)
>  
>  /**
>   * target_submit - perform final initialization and submit cmd to LIO core
> - * @cmd: command descriptor to submit
> + * @se_cmd: command descriptor to submit
>   *
>   * target_submit_prep or something similar must have been called on the cmd,
>   * and this must be called from process context.

Thanks.

Reviewed-by: Mike Christie <michael.christie@oracle.com>