Re: [PATCH v2 2/3] qapi: Document some missing details of RTC_CHANGE event

[Markus Armbruster]

Peter Maydell <peter.maydell@linaro.org> writes:

> The RTC_CHANGE event's documentation is missing some details:
>  * the offset argument is in units of seconds
>  * it isn't guaranteed that the RTC will implement the event
>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
> ---
> v1->v2: add the "RTC might not implement this" note
> ---
>  qapi/misc.json | 6 ++++--
>  1 file changed, 4 insertions(+), 2 deletions(-)
>
> diff --git a/qapi/misc.json b/qapi/misc.json
> index 7a70eaa3ffc..0ab235e41f7 100644
> --- a/qapi/misc.json
> +++ b/qapi/misc.json
> @@ -533,10 +533,12 @@
>  #
>  # Emitted when the guest changes the RTC time.
>  #
> -# @offset: offset between base RTC clock (as specified by -rtc base), and
> -#          new RTC clock value
> +# @offset: offset in seconds between base RTC clock (as specified
> +#          by -rtc base), and new RTC clock value
>  #
>  # Note: This event is rate-limited.
> +#       It is not guaranteed that the RTC in the system implements
> +#       this event, or even that the system has an RTC at all.
>  #
>  # Since: 0.13
>  #

Reviewed-by: Markus Armbruster <armbru@redhat.com>