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: add40e9777 ("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>
This commit is contained in:
Philippe Mathieu-Daudé 2020-09-20 17:50:42 +02:00 committed by Laurent Vivier
parent 9e32d4ead3
commit 420bd5660b

View File

@ -679,7 +679,7 @@ void timer_mod(QEMUTimer *ts, int64_t expire_timer);
/** /**
* timer_mod_anticipate: * timer_mod_anticipate:
* @ts: the timer * @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 * Modify a timer to expire at @expire_time or the current time, whichever
* comes earlier, taking into account the scale associated with the timer. * comes earlier, taking into account the scale associated with the timer.