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>
Message-Id: <
20220221192123.749970-3-peter.maydell@linaro.org>
Reviewed-by: Philippe Mathieu-Daudé <f4bug@amsat.org>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
#
# 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
#