diff mbox series

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

Message ID 20231017030913.89973-1-yang.lee@linux.alibaba.com
State New
Headers
Series [-next] scsi: target: core: Fix one kernel-doc comment |

Commit Message

Yang Li Oct. 17, 2023, 3:09 a.m. UTC 
  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(-)

Comments

Mike Christie Oct. 17, 2023, 3:49 p.m. UTC | #1 
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>
Martin K. Petersen Oct. 25, 2023, 2:23 a.m. UTC | #2 
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 Oct. 30, 2023, 3:34 p.m. UTC | #3 
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
diff mbox series

Patch

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.