From: Marc-André Lureau <marcandre.lureau@redhat.com>
Date: Thu, 23 Jun 2016 13:52:56 +0000 (+0200)
Subject: qmp-events: move 'BLOCK_JOB_COMPLETED' doc to schema
X-Git-Url: http://git.maquefel.me/?a=commitdiff_plain;h=e21e65b212612083439a68f18b44e373aa38de00;p=qemu.git

qmp-events: move 'BLOCK_JOB_COMPLETED' doc to schema

Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---

diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt
index dc5bce111b..9b42f407d4 100644
--- a/docs/qmp-events.txt
+++ b/docs/qmp-events.txt
@@ -55,36 +55,6 @@ Example:
                "speed": 0 },
      "timestamp": { "seconds": 1267061043, "microseconds": 959568 } }
 
-BLOCK_JOB_COMPLETED
--------------------
-
-Emitted when a block job has completed.
-
-Data:
-
-- "type":     Job type (json-string; "stream" for image streaming
-                                     "commit" for block commit)
-- "device":   Job identifier. Originally the device name but other
-              values are allowed since QEMU 2.7 (json-string)
-- "len":      Maximum progress value (json-int)
-- "offset":   Current progress value (json-int)
-              On success this is equal to len.
-              On failure this is less than len.
-- "speed":    Rate limit, bytes per second (json-int)
-- "error":    Error message (json-string, optional)
-              Only present on failure.  This field contains a human-readable
-              error message.  There are no semantics other than that streaming
-              has failed and clients should not try to interpret the error
-              string.
-
-Example:
-
-{ "event": "BLOCK_JOB_COMPLETED",
-     "data": { "type": "stream", "device": "virtio-disk0",
-               "len": 10737418240, "offset": 10737418240,
-               "speed": 0 },
-     "timestamp": { "seconds": 1267061043, "microseconds": 959568 } }
-
 BLOCK_JOB_ERROR
 ---------------
 
diff --git a/qapi/block-core.json b/qapi/block-core.json
index 89af577625..abfa182846 100644
--- a/qapi/block-core.json
+++ b/qapi/block-core.json
@@ -3308,6 +3308,15 @@
 #         interpret the error string
 #
 # Since: 1.1
+#
+# Example:
+#
+# <- { "event": "BLOCK_JOB_COMPLETED",
+#      "data": { "type": "stream", "device": "virtio-disk0",
+#                "len": 10737418240, "offset": 10737418240,
+#                "speed": 0 },
+#      "timestamp": { "seconds": 1267061043, "microseconds": 959568 } }
+#
 ##
 { 'event': 'BLOCK_JOB_COMPLETED',
   'data': { 'type'  : 'BlockJobType',