Skip to contentSkip to conversation

clocksource/drivers/timer-ti-dm: Fix some kernel-doc comments

PATCH In review Yang Li 3 participants 3 messages Oct 14, 2022 Clocksource, clockevent drivers

lore
Share & tools
lore

Yang Li

author
#0 lore raw

PATCH 1/1 clocksource/drivers/timer-ti-dm: Fix some kernel-doc comments

Fix some kernel-doc comments.

---
 drivers/clocksource/timer-ti-dm.c | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)
drivers/clocksource/timer-ti-dm.c +2 -3
index cad29ded3a48..574c88584fbf 100644
@@ -181,8 +181,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
@@ -925,7 +924,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 omap dm timer handle
  * @mask:	bit mask of interrupts to be disabled
  *
  * Disables the specified timer interrupts for a timer.
Signature · 1 line
2.20.1.7.g153144c
#1 lore raw
Quoted 3 lines · Yang Li

Fix some kernel-doc comments.

What fix are you doing below? Please describe (should contain warning messages from bugzilla link above).

---- ranting ----
When I see social media posts, I often see "Link in bio" phrase. That is, instead of posting the full link, the link is placed on URL section of a poster's bio and a pointer to it is phrased in relevant posts. What if such "link in bio" link changes? The older posts which points to different link than in the bio become irrelevant.

I would rather just spell the full link in my posts instead for posterity.
---- end ranting ----

Quoted 15 lines
drivers/clocksource/timer-ti-dm.c +1 -2
index cad29ded3a48..574c88584fbf 100644
@@ -181,8 +181,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

drivers/clocksource/timer-ti-dm.c static int omap_dm_timer_set_int_enable(struct omap_dm_timer *cookie, · line 930

Quoted 8 lines
drivers/clocksource/timer-ti-dm.c +1 -1
@@ -925,7 +924,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 omap dm timer handle
  * @mask:	bit mask of interrupts to be disabled
  *
  * Disables the specified timer interrupts for a timer.

Seems like two different fixes, right? These should be splitted into its own patch.

Thanks.

Signature · 1 line
An old man doll... just what I always wanted! - Clara
#2 lore raw
Quoted 7 lines · Bagas Sanjaya
Quoted 3 lines · Yang Li

Fix some kernel-doc comments.

What fix are you doing below? Please describe (should contain warning messages from bugzilla link above).

Yeah, we don't need that link, just the warning messages themselves.

Quoted 27 lines

---- ranting ----
When I see social media posts, I often see "Link in bio" phrase. That is, instead of posting the full link, the link is placed on URL section of a poster's bio and a pointer to it is phrased in relevant posts. What if such "link in bio" link changes? The older posts which points to different link than in the bio become irrelevant.

I would rather just spell the full link in my posts instead for posterity.
---- end ranting ----

Quoted 16 lines
drivers/clocksource/timer-ti-dm.c +1 -2
index cad29ded3a48..574c88584fbf 100644
@@ -181,8 +181,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
@@ -925,7 +924,7 @@ static int omap_dm_timer_set_int_enable(struct omap_dm_timer *cookie,
 
Quoted 10 lines

drivers/clocksource/timer-ti-dm.c static int omap_dm_timer_set_int_enable(struct omap_dm_timer *cookie, · line 930

Quoted 7 lines
drivers/clocksource/timer-ti-dm.c +1 -1
 /**
  * omap_dm_timer_set_int_disable - disable timer interrupts
- * @timer:	pointer to timer handle
+ * @cookie:	pointer to omap dm timer handle
  * @mask:	bit mask of interrupts to be disabled
  *
  * Disables the specified timer interrupts for a timer.

Seems like two different fixes, right? These should be splitted into its own patch.

That's up to the maintainer IMO.
If I were making this patch, it would be as above, just one patch.

Signature · 1 line
~Randy