tick/nohz: Improve tick_nohz_get_next_hrtimer() kerneldoc

RFC PATCH New Rafael J. Wysocki 1 participant 1 message Mar 29, 2021 1 message not in the archive Nohz, dynticks support

lore

Share & tools

lore

A message that is not in the archive (sent off-list or not yet received): 2188825.ElGaqSPkdT@kreacher

Rafael J. Wysocki

author

2021-03-29 18:38 UTC #1 lore raw

RFC PATCH 1/5 tick/nohz: Improve tick_nohz_get_next_hrtimer() kerneldoc

From: "Rafael J. Wysocki" <[email protected]>

Make the tick_nohz_get_next_hrtimer() kerneldoc comment state clearly that the function may return negative numbers.

Signed-off-by Rafael J. Wysocki <[email protected]>

---
 kernel/time/tick-sched.c |    6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

kernel/time/tick-sched.c +5 -1

Index: linux-pm/kernel/time/tick-sched.c
===================================================================
@@ -1124,7 +1124,11 @@ ktime_t tick_nohz_get_next_hrtimer(void)
  * tick_nohz_get_sleep_length - return the expected length of the current sleep
  * @delta_next: duration until the next event if the tick cannot be stopped
  *
- * Called from power state control code with interrupts disabled
+ * Called from power state control code with interrupts disabled.
+ *
+ * The return value of this function and/or the value returned by it through the
+ * @delta_next pointer can be negative which must be taken into account by its
+ * callers.
  */
 ktime_t tick_nohz_get_sleep_length(ktime_t *delta_next)
 {