diff mbox series

[PULL,6/9] qapi: Document some missing details of RTC_CHANGE event

Message ID 20220228112613.520040-7-armbru@redhat.com
State Accepted
Commit e67e3a48c0b1aa816a192e2c506a6f90dcfc9530
Headers show
Series None | expand

Commit Message

Markus Armbruster Feb. 28, 2022, 11:26 a.m. UTC 
From: Peter Maydell <peter.maydell@linaro.org>

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>
---
 qapi/misc.json | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)
diff mbox series

Patch

diff --git a/qapi/misc.json b/qapi/misc.json
index 7a70eaa3ff..0ab235e41f 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
 #