aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPhilippe Mathieu-Daudé <f4bug@amsat.org>2020-09-20 17:50:42 +0200
committerLaurent Vivier <laurent@vivier.eu>2020-09-23 19:13:01 +0200
commit420bd5660b87f3d3ebca58548f14548c984fab82 (patch)
treec44320684bf20f912dcc4c021f6d52f48ed21d1d
parent9e32d4ead3531f70d26e374219884d42e5d8b170 (diff)
downloadqemu-420bd5660b87f3d3ebca58548f14548c984fab82.zip
qemu-420bd5660b87f3d3ebca58548f14548c984fab82.tar.gz
qemu-420bd5660b87f3d3ebca58548f14548c984fab82.tar.bz2
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>
-rw-r--r--include/qemu/timer.h2
1 files changed, 1 insertions, 1 deletions
diff --git a/include/qemu/timer.h b/include/qemu/timer.h
index 6a8b48b..1dc880e 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.