Skip to contentSkip to conversation

clockevents: fix doc warnings in clockevents.c

PATCH Applied Baokun Li 2 participants 2 messages Jun 8, 2021 – Jun 22, 2021 High-resolution timers, timer wheel, clockevents

lore
Share & tools
lore

Baokun Li

author
#0 lore raw

PATCH 1/1 clockevents: fix doc warnings in clockevents.c

Add description for tick_cleanup_dead_cpu to fix the W=1 warnings:

kernel/time/clockevents.c:634: warning: Function parameter or
member 'cpu' not described in 'tick_cleanup_dead_cpu'

---
 kernel/time/clockevents.c | 1 +
 1 file changed, 1 insertion(+)
kernel/time/clockevents.c +1 -0
index 0056d2bed53e..bb9d2fe58480 100644
@@ -629,6 +629,7 @@ void tick_offline_cpu(unsigned int cpu)
 
 /**
  * tick_cleanup_dead_cpu - Cleanup the tick and clockevents of a dead cpu
+ * @cpu:	The dead CPU
  */
 void tick_cleanup_dead_cpu(int cpu)
 {
Signature · 1 line
2.31.1
merge bot Applied
#1 lore raw

[tip: timers/core] clockevents: Add missing parameter documentation

The following commit has been merged into the timers/core branch of tip:

The following commit has been merged into the timers/core branch of tip:

Commit-ID:     64ab7071254c178e81a6d0203354aad6521258ea
Gitweb:        https://git.kernel.org/tip/64ab7071254c178e81a6d0203354aad6521258ea
Author:        Baokun Li <[email protected]>
AuthorDate:    Tue, 08 Jun 2021 10:43:05 +08:00
Committer:     Thomas Gleixner <[email protected]>
CommitterDate: Tue, 22 Jun 2021 16:33:16 +02:00

clockevents: Add missing parameter documentation

Add the missing documentation for the @cpu parameter of tick_cleanup_dead_cpu().

---
 kernel/time/clockevents.c | 1 +
 1 file changed, 1 insertion(+)
kernel/time/clockevents.c +1 -0
index 0056d2b..bb9d2fe 100644
@@ -629,6 +629,7 @@ void tick_offline_cpu(unsigned int cpu)
 
 /**
  * tick_cleanup_dead_cpu - Cleanup the tick and clockevents of a dead cpu
+ * @cpu:	The dead CPU
  */
 void tick_cleanup_dead_cpu(int cpu)
 {