summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMarkus Armbruster <armbru@redhat.com>2014-06-27 19:24:15 +0200
committerLuiz Capitulino <lcapitulino@redhat.com>2014-06-27 13:40:41 -0400
commita22d8e47f7efb15a96162b92b50f8fb108b1c5d9 (patch)
treea5751cfff2f6cf62e681187e21c20ea499a19dcd /docs
parent32a97ea1711f43388e178b7c43e02143a61e47ee (diff)
downloadqemu-a22d8e47f7efb15a96162b92b50f8fb108b1c5d9.tar.gz
qemu-a22d8e47f7efb15a96162b92b50f8fb108b1c5d9.tar.bz2
qemu-a22d8e47f7efb15a96162b92b50f8fb108b1c5d9.zip
docs/qmp: Fix documentation of BLOCK_JOB_READY to match code
Signed-off-by: Markus Armbruster <armbru@redhat.com> Signed-off-by: Luiz Capitulino <lcapitulino@redhat.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/qmp/qmp-events.txt12
1 files changed, 10 insertions, 2 deletions
diff --git a/docs/qmp/qmp-events.txt b/docs/qmp/qmp-events.txt
index 22fea580a9..44be891261 100644
--- a/docs/qmp/qmp-events.txt
+++ b/docs/qmp/qmp-events.txt
@@ -157,12 +157,20 @@ Emitted when a block job is ready to complete.
Data:
-- "device": device name (json-string)
+- "type": Job type (json-string; "stream" for image streaming
+ "commit" for block commit)
+- "device": Device name (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)
Example:
{ "event": "BLOCK_JOB_READY",
- "data": { "device": "ide0-hd1" },
+ "data": { "device": "drive0", "type": "mirror", "speed": 0,
+ "len": 2097152, "offset": 2097152 }
"timestamp": { "seconds": 1265044230, "microseconds": 450486 } }
Note: The "ready to complete" status is always reset by a BLOCK_JOB_ERROR