diff mbox series

[PULL,6/8] timer: Fix timer_mod_anticipate() documentation

Message ID 20200928091602.383870-7-laurent@vivier.eu
State New
Headers show
Series Trivial branch for 5.2 patches | expand

Commit Message

Laurent Vivier Sept. 28, 2020, 9:16 a.m. UTC 
From: Philippe Mathieu-Daudé <f4bug@amsat.org>

timer_mod_anticipate() will be scaled to the timer unit,
which is not always nanosecond. Fix the documentation.

Fixes: add40e9777d ("timer: add timer_mod_anticipate*")
Signed-off-by: Philippe Mathieu-Daudé <f4bug@amsat.org>
Reviewed-by: Richard Henderson <richard.henderson@linaro.org>
Message-Id: <20200920155042.400737-1-f4bug@amsat.org>
Signed-off-by: Laurent Vivier <laurent@vivier.eu>
---
 include/qemu/timer.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
diff mbox series

Patch

diff --git a/include/qemu/timer.h b/include/qemu/timer.h
index 6a8b48b5a9d8..1dc880e94e76 100644
--- a/include/qemu/timer.h
+++ b/include/qemu/timer.h
@@ -679,7 +679,7 @@  void timer_mod(QEMUTimer *ts, int64_t expire_timer);
 /**
  * timer_mod_anticipate:
  * @ts: the timer
- * @expire_time: the expiry time in nanoseconds
+ * @expire_time: the expire time in the units associated with the timer
  *
  * Modify a timer to expire at @expire_time or the current time, whichever
  * comes earlier, taking into account the scale associated with the timer.