Skip to content

Commit

Permalink
docs/qmp: Fix documentation of BLOCK_JOB_READY to match code
Browse files Browse the repository at this point in the history
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Luiz Capitulino <lcapitulino@redhat.com>
  • Loading branch information
Markus Armbruster authored and Luiz Capitulino committed Jun 27, 2014
1 parent 32a97ea commit a22d8e4
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions docs/qmp/qmp-events.txt
Expand Up @@ -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
Expand Down

0 comments on commit a22d8e4

Please sign in to comment.