Re: [Qemu-devel] [PATCH v2 2.1 3/3] docs/qmp: Fix documentation of BLOCK_JOB_READY to match code

[Luiz Capitulino <lcapitulino@redhat.com>]

On Fri, 27 Jun 2014 19:24:15 +0200
Markus Armbruster <armbru@redhat.com> wrote:

> Signed-off-by: Markus Armbruster <armbru@redhat.com>

I've cherry picked this one as this file only exists in qmp tree.

> ---
>  docs/qmp/qmp-events.txt | 12 ++++++++++--
>  1 file changed, 10 insertions(+), 2 deletions(-)
> 
> diff --git a/docs/qmp/qmp-events.txt b/docs/qmp/qmp-events.txt
> index 22fea58..44be891 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