Re: [Qemu-devel] [PULL v2 11/34] blockjob: Update description of the 'device' field in the QMP API

[Eric Blake]

On 07/13/2016 06:50 AM, Kevin Wolf wrote:
> From: Alberto Garcia <address@hidden>
> 
> The 'device' field in all BLOCK_JOB_* events and 'block-job-*' command
> is no longer the device name, but the ID of the job. This patch
> updates the documentation to clarify that.
> 
> Signed-off-by: Alberto Garcia <address@hidden>
> Reviewed-by: Max Reitz <address@hidden>
> Reviewed-by: Kevin Wolf <address@hidden>
> Signed-off-by: Kevin Wolf <address@hidden>
> ---
>  docs/qmp-events.txt  | 12 ++++++++----
>  qapi/block-core.json | 35 +++++++++++++++++++++++++----------
>  2 files changed, 33 insertions(+), 14 deletions(-)
> 

> +++ b/qapi/block-core.json
> @@ -713,7 +713,8 @@
>  #
>  # @type: the job type ('stream' for image streaming)
>  #
> -# @device: the block device name
> +# @device: The job identifier. Originally the device name but other
> +#          values are allowed since QEMU 2.7
>  #
>  # @len: the maximum progress value
>  #
> @@ -1475,7 +1476,9 @@
>  #
>  # Throttling can be disabled by setting the speed to 0.
>  #
> -# @device: the device name
> +# @device: The job identifier. This used to be a device name (hence
> +#          the name of the parameter), but since QEMU 2.7 it can have
> +#          other values.

It might have been nice to use the same wording everywhere, instead of
writing two different things, but it's not the end of the world, and I'm
fine if we keep it as committed.


-- 
Eric Blake   eblake redhat com    +1-919-301-3266
Libvirt virtualization library http://libvirt.org

signature.asc
Description: OpenPGP digital signature