diff mbox

[v2,for-2.1,3/5] docs: document missing SPICE_MIGRATE_COMPLETED event

Message ID 1406118378-11217-4-git-send-email-eblake@redhat.com
State New
Headers show

Commit Message

Eric Blake July 23, 2014, 12:26 p.m. UTC
The SPICE_MIGRATE_COMPLETED event was first documented in
7cfadb6b.  But since dfab4892 later restored this flie to the
state prior to qmp events, and we never documented it in the
past, anyone using this file instead of qapi will miss out on
this event.

* docs/qmp/qmp-events.txt (SPICE_MIGRATE_COMPLETED): Add.

Signed-off-by: Eric Blake <eblake@redhat.com>
---
 docs/qmp/qmp-events.txt | 13 +++++++++++++
 1 file changed, 13 insertions(+)

Comments

Markus Armbruster July 23, 2014, 1:43 p.m. UTC | #1
Eric Blake <eblake@redhat.com> writes:

> The SPICE_MIGRATE_COMPLETED event was first documented in
> 7cfadb6b.  But since dfab4892 later restored this flie to the

"this file"

> state prior to qmp events, and we never documented it in the
> past, anyone using this file instead of qapi will miss out on
> this event.
>
> * docs/qmp/qmp-events.txt (SPICE_MIGRATE_COMPLETED): Add.
>
> Signed-off-by: Eric Blake <eblake@redhat.com>

Patch is fine.
diff mbox

Patch

diff --git a/docs/qmp/qmp-events.txt b/docs/qmp/qmp-events.txt
index 9b7ee7c..22d552f 100644
--- a/docs/qmp/qmp-events.txt
+++ b/docs/qmp/qmp-events.txt
@@ -424,6 +424,19 @@  Example:
                       "channel-id": 0, "tls": true}
 }}

+SPICE_MIGRATE_COMPLETED
+-----------------------
+
+Emitted when SPICE migration has completed
+
+Data: None.
+
+Example:
+
+{ "timestamp": {"seconds": 1290688046, "microseconds": 417172},
+  "event": "SPICE_MIGRATE_COMPLETED" }
+
+
 STOP
 ----