Skip to contentSkip to conversation

scsi: target: core: Fix one kernel-doc comment

PATCH Applied Yang Li 3 participants 4 messages Oct 17, 2023 – Oct 30, 2023

Subsystems (2)
lore
Share & tools
lore

Yang Li

author
#0 lore raw

PATCH 1/1 scsi: target: core: Fix one kernel-doc comment

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'

---
 drivers/target/target_core_transport.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/target/target_core_transport.c +1 -1
index c81def3c96df..670cfb7bd426 100644
@@ -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.
Signature · 1 line
2.20.1.7.g153144c
Reviewed-by on v1 1/1
#1 lore raw
Quoted 16 lines · Yang Li

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'

---
 drivers/target/target_core_transport.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/target/target_core_transport.c +0 -0
index c81def3c96df..670cfb7bd426 100644

drivers/target/target_core_transport.c static void target_queue_submission(struct se_cmd *se_cmd) · line 1927

Quoted 8 lines
drivers/target/target_core_transport.c +1 -1
@@ -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.

#2 lore raw
In reply to Yang Li

Yang,

Quoted 5 lines

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!

Signature · 1 line
Martin K. Petersen	Oracle Linux Engineering
#3 lore raw
In reply to Yang Li
Quoted 5 lines · Yang Li

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
Signature · 1 line
Martin K. Petersen	Oracle Linux Engineering