[PATCH -next] thunderbolt: Fix some kernel-doc comments

Yang Li posted 1 patch 3 years, 11 months ago
drivers/thunderbolt/ctl.c | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
[PATCH -next] thunderbolt: Fix some kernel-doc comments
Posted by Yang Li 3 years, 11 months ago
Remove some warnings found by running scripts/kernel-doc,
which is caused by using 'make W=1'.

drivers/thunderbolt/ctl.c:701: warning: expecting prototype for
tb_cfg_start(). Prototype was for tb_ctl_start() instead
drivers/thunderbolt/ctl.c:722: warning: expecting prototype for
tb_ctrl_stop(). Prototype was for tb_ctl_stop() instead
drivers/thunderbolt/ctl.c:930: warning: expecting prototype for
tb_cfg_write(). Prototype was for tb_cfg_write_raw() instead

Reported-by: Abaci Robot <abaci@linux.alibaba.com>
Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
---
 drivers/thunderbolt/ctl.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/drivers/thunderbolt/ctl.c b/drivers/thunderbolt/ctl.c
index e92c658dba1c..e5ede5debfb0 100644
--- a/drivers/thunderbolt/ctl.c
+++ b/drivers/thunderbolt/ctl.c
@@ -694,7 +694,7 @@ void tb_ctl_free(struct tb_ctl *ctl)
 }
 
 /**
- * tb_cfg_start() - start/resume the control channel
+ * tb_ctl_start() - start/resume the control channel
  * @ctl: Control channel to start
  */
 void tb_ctl_start(struct tb_ctl *ctl)
@@ -710,7 +710,7 @@ void tb_ctl_start(struct tb_ctl *ctl)
 }
 
 /**
- * tb_ctrl_stop() - pause the control channel
+ * tb_ctl_stop() - pause the control channel
  * @ctl: Control channel to stop
  *
  * All invocations of ctl->callback will have finished after this method
@@ -912,7 +912,7 @@ struct tb_cfg_result tb_cfg_read_raw(struct tb_ctl *ctl, void *buffer,
 }
 
 /**
- * tb_cfg_write() - write from buffer into config space
+ * tb_cfg_write_raw() - write from buffer into config space
  * @ctl: Pointer to the control channel
  * @buffer: Data to write
  * @route: Route string of the router
-- 
2.20.1.7.g153144c
Re: [PATCH -next] thunderbolt: Fix some kernel-doc comments
Posted by Mika Westerberg 3 years, 10 months ago
On Thu, May 26, 2022 at 09:01:54PM +0800, Yang Li wrote:
> Remove some warnings found by running scripts/kernel-doc,
> which is caused by using 'make W=1'.
> 
> drivers/thunderbolt/ctl.c:701: warning: expecting prototype for
> tb_cfg_start(). Prototype was for tb_ctl_start() instead
> drivers/thunderbolt/ctl.c:722: warning: expecting prototype for
> tb_ctrl_stop(). Prototype was for tb_ctl_stop() instead
> drivers/thunderbolt/ctl.c:930: warning: expecting prototype for
> tb_cfg_write(). Prototype was for tb_cfg_write_raw() instead
> 
> Reported-by: Abaci Robot <abaci@linux.alibaba.com>
> Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>

Applied to thunderbolt.git/next, thanks!