[PATCH] alarmtimer: Fix kerneldoc comment for alarmtimer_suspend()

[PATCH] alarmtimer: Fix kerneldoc comment for alarmtimer_suspend()

[Zhan Xusheng]

Updated comment to explain that `dev` is used for scheduling
wake-up events.

Signed-off-by: Zhan Xusheng <zhanxusheng@xiaomi.com>
---
 kernel/time/alarmtimer.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/kernel/time/alarmtimer.c b/kernel/time/alarmtimer.c
index 069d93bfb0c7..2548292b207d 100644
--- a/kernel/time/alarmtimer.c
+++ b/kernel/time/alarmtimer.c
@@ -208,7 +208,7 @@ EXPORT_SYMBOL_GPL(alarm_expires_remaining);
 #ifdef CONFIG_RTC_CLASS
 /**
  * alarmtimer_suspend - Suspend time callback
- * @dev: unused
+ * @dev: the device that triggered the suspend, used for wake-up event
  *
  * When we are going into suspend, we look through the bases
  * to see which is the soonest timer to expire. We then
-- 
2.43.0

Re: [PATCH] alarmtimer: Fix kerneldoc comment for alarmtimer_suspend()

[Thomas Gleixner]

On Thu, Feb 05 2026 at 16:51, Zhan Xusheng wrote:
> Updated comment to explain that `dev` is used for scheduling
> wake-up events.

That's just wrong.

> Signed-off-by: Zhan Xusheng <zhanxusheng@xiaomi.com>
> ---
>  kernel/time/alarmtimer.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/kernel/time/alarmtimer.c b/kernel/time/alarmtimer.c
> index 069d93bfb0c7..2548292b207d 100644
> --- a/kernel/time/alarmtimer.c
> +++ b/kernel/time/alarmtimer.c
> @@ -208,7 +208,7 @@ EXPORT_SYMBOL_GPL(alarm_expires_remaining);
>  #ifdef CONFIG_RTC_CLASS
>  /**
>   * alarmtimer_suspend - Suspend time callback
> - * @dev: unused
> + * @dev: the device that triggered the suspend, used for wake-up event

Which device triggered the suspend? Surely not @dev.

The code does not care about @dev as documented because it uses its
own mechanism to retrieve the wakeup RTC device.

So you replace a perfectly correct comment with incomprehensible
garbage. What's the improvement here?

Thanks,

        tglx