From: Philippe Mathieu-Daudé <f4bug@amsat.org>
Date: Sun, 20 Sep 2020 15:50:42 +0000 (+0200)
Subject: timer: Fix timer_mod_anticipate() documentation
X-Git-Url: http://git.maquefel.me/?a=commitdiff_plain;h=420bd5660b87f3d3ebca58548f14548c984fab82;p=qemu.git

timer: Fix timer_mod_anticipate() documentation

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>
---

diff --git a/include/qemu/timer.h b/include/qemu/timer.h
index 6a8b48b5a9..1dc880e94e 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.