2023-11-01 01:52:35

by Yang Li

Subject: [PATCH -next] clocksource: Fix some kernel-doc comments

Fix some kernel-doc comments to silence the warnings:
drivers/clocksource/timer-ti-dm.c:193: warning: Function parameter or member 'val' not described in 'dmtimer_write'
drivers/clocksource/timer-ti-dm.c:193: warning: Excess function parameter 'value' description in 'dmtimer_write'
drivers/clocksource/timer-ti-dm.c:958: warning: Function parameter or member 'cookie' not described in 'omap_dm_timer_set_int_disable'
drivers/clocksource/timer-ti-dm.c:958: warning: Excess function parameter 'timer' description in 'omap_dm_timer_set_int_disable'

Reported-by: Abaci Robot <[email protected]>
Closes: https://bugzilla.openanolis.cn/show_bug.cgi?id=7106
Signed-off-by: Yang Li <[email protected]>
---
drivers/clocksource/timer-ti-dm.c | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/drivers/clocksource/timer-ti-dm.c b/drivers/clocksource/timer-ti-dm.c
index 5f60f6bd3386..89e3f4af353e 100644
--- a/drivers/clocksource/timer-ti-dm.c
+++ b/drivers/clocksource/timer-ti-dm.c
@@ -183,7 +183,7 @@ static inline u32 dmtimer_read(struct dmtimer *timer, u32 reg)
* dmtimer_write - write timer registers in posted and non-posted mode
* @timer: timer pointer over which write operation is to perform
* @reg: lowest byte holds the register offset
- * @value: data to write into the register
+ * @val: data to write into the register
*
* The posted mode bit is encoded in reg. Note that in posted mode, the write
* pending bit must be checked. Otherwise a write on a register which has a
@@ -949,7 +949,7 @@ static int omap_dm_timer_set_int_enable(struct omap_dm_timer *cookie,

/**
* omap_dm_timer_set_int_disable - disable timer interrupts
- * @timer: pointer to timer handle
+ * @cookie: pointer to timer handle
* @mask: bit mask of interrupts to be disabled
*
* Disables the specified timer interrupts for a timer.
--
2.20.1.7.g153144c

2023-11-01 01:57:41

by Randy Dunlap

Subject: Re: [PATCH -next] clocksource: Fix some kernel-doc comments

On 10/31/23 18:52, Yang Li wrote:
> Fix some kernel-doc comments to silence the warnings:
> drivers/clocksource/timer-ti-dm.c:193: warning: Function parameter or member 'val' not described in 'dmtimer_write'
> drivers/clocksource/timer-ti-dm.c:193: warning: Excess function parameter 'value' description in 'dmtimer_write'
> drivers/clocksource/timer-ti-dm.c:958: warning: Function parameter or member 'cookie' not described in 'omap_dm_timer_set_int_disable'
> drivers/clocksource/timer-ti-dm.c:958: warning: Excess function parameter 'timer' description in 'omap_dm_timer_set_int_disable'
>
> Reported-by: Abaci Robot <[email protected]>
> Closes: https://bugzilla.openanolis.cn/show_bug.cgi?id=7106
> Signed-off-by: Yang Li <[email protected]>
> ---
> drivers/clocksource/timer-ti-dm.c | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>

Acked-by: Randy Dunlap <[email protected]>

Thanks.

--
~Randy