timer: Fix timer_mod_anticipate() documentation

[PATCH] timer: Fix timer_mod_anticipate() documentation

Posted by Philippe Mathieu-Daudé 3 years, 7 months ago

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>
---
 include/qemu/timer.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

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

Re: [PATCH] timer: Fix timer_mod_anticipate() documentation

Posted by Richard Henderson 3 years, 7 months ago

On 9/20/20 8:50 AM, Philippe Mathieu-Daudé wrote:
> 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>
> ---
>  include/qemu/timer.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)

Reviewed-by: Richard Henderson <richard.henderson@linaro.org>

r~

Re: [PATCH] timer: Fix timer_mod_anticipate() documentation

Posted by Laurent Vivier 3 years, 7 months ago

Le 20/09/2020 à 17:50, Philippe Mathieu-Daudé a écrit :
> 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>
> ---
>  include/qemu/timer.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/include/qemu/timer.h b/include/qemu/timer.h
> index 6a8b48b5a9d..1dc880e94e7 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.
> 

Applied to my trivial-patches branch.

Thanks,
Laurent