qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: Markus Armbruster <armbru@redhat.com>
To: qemu-devel@nongnu.org
Cc: peter.maydell@linaro.org, "Philippe Mathieu-Daudé" <f4bug@amsat.org>
Subject: [PULL 6/9] qapi: Document some missing details of RTC_CHANGE event
Date: Mon, 28 Feb 2022 12:26:10 +0100	[thread overview]
Message-ID: <20220228112613.520040-7-armbru@redhat.com> (raw)
In-Reply-To: <20220228112613.520040-1-armbru@redhat.com>

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 --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
 #
-- 
2.35.1



  parent reply	other threads:[~2022-02-28 11:34 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-02-28 11:26 [PULL 0/9] QAPI patches patches for 2022-02-28 Markus Armbruster
2022-02-28 11:26 ` [PULL 1/9] scripts/qapi: minor delinting Markus Armbruster
2022-02-28 11:26 ` [PULL 2/9] keyval: Fix grammar comment to cover downstream prefix Markus Armbruster
2022-02-28 11:26 ` [PULL 3/9] qapi: Fix stale reference to scripts/qapi.py in a comment Markus Armbruster
2022-02-28 11:26 ` [PULL 4/9] qapi/migration: Fix examples document wrong field name for arguments Markus Armbruster
2022-02-28 11:26 ` [PULL 5/9] qapi: Move RTC_CHANGE back out of target schema Markus Armbruster
2022-02-28 11:26 ` Markus Armbruster [this message]
2022-02-28 11:26 ` [PULL 7/9] hw/rtc: Compile pl031 once-only Markus Armbruster
2022-02-28 11:26 ` [PULL 8/9] rtc: Have event RTC_CHANGE identify the RTC by QOM path Markus Armbruster
2022-02-28 11:26 ` [PULL 9/9] qapi: Belatedly adjust limitations documentation Markus Armbruster
2022-03-01 13:25 ` [PULL 0/9] QAPI patches patches for 2022-02-28 Peter Maydell

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20220228112613.520040-7-armbru@redhat.com \
    --to=armbru@redhat.com \
    --cc=f4bug@amsat.org \
    --cc=peter.maydell@linaro.org \
    --cc=qemu-devel@nongnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).