2021-06-08 02:36:48

by Baokun Li

Subject: [PATCH -next] 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'

Signed-off-by: Baokun Li <[email protected]>
---
kernel/time/clockevents.c | 1 +
1 file changed, 1 insertion(+)

diff --git a/kernel/time/clockevents.c b/kernel/time/clockevents.c
index 0056d2bed53e..bb9d2fe58480 100644
--- a/kernel/time/clockevents.c
+++ b/kernel/time/clockevents.c
@@ -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)
{
--
2.31.1

2021-06-22 14:36:23

by tip-bot2 for Alexey Makhalov

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

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().

Signed-off-by: Baokun Li <[email protected]>
Signed-off-by: Thomas Gleixner <[email protected]>
Link: https://lore.kernel.org/r/[email protected]

---
kernel/time/clockevents.c | 1 +
1 file changed, 1 insertion(+)

diff --git a/kernel/time/clockevents.c b/kernel/time/clockevents.c
index 0056d2b..bb9d2fe 100644
--- a/kernel/time/clockevents.c
+++ b/kernel/time/clockevents.c
@@ -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)
{