[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [Qemu-block] [PATCH v3 11/11] blockjob: Update description of the 'd
From: |
Max Reitz |
Subject: |
Re: [Qemu-block] [PATCH v3 11/11] blockjob: Update description of the 'device' field in the QMP API |
Date: |
Sat, 2 Jul 2016 16:37:51 +0200 |
User-agent: |
Mozilla/5.0 (X11; Linux x86_64; rv:45.0) Gecko/20100101 Thunderbird/45.1.1 |
On 01.07.2016 17:52, Alberto Garcia wrote:
> 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>
> ---
> docs/qmp-events.txt | 12 ++++++++----
> qapi/block-core.json | 35 +++++++++++++++++++++++++----------
> 2 files changed, 33 insertions(+), 14 deletions(-)
>
> diff --git a/docs/qmp-events.txt b/docs/qmp-events.txt
> index fa7574d..a0ad3ac 100644
> --- a/docs/qmp-events.txt
> +++ b/docs/qmp-events.txt
> @@ -92,7 +92,8 @@ Data:
>
> - "type": Job type (json-string; "stream" for image streaming
> "commit" for block commit)
> -- "device": Device name (json-string)
> +- "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.
> @@ -116,7 +117,8 @@ Data:
>
> - "type": Job type (json-string; "stream" for image streaming
> "commit" for block commit)
> -- "device": Device name (json-string)
> +- "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.
> @@ -143,7 +145,8 @@ Emitted when a block job encounters an error.
>
> Data:
>
> -- "device": device name (json-string)
> +- "device": job identifier. Originally the device name but other
> + values are allowed since QEMU 2.7 (json-string)
> - "operation": I/O operation (json-string, "read" or "write")
> - "action": action that has been taken, it's one of the following
> (json-string):
> "ignore": error has been ignored, the job may fail later
> @@ -167,7 +170,8 @@ Data:
>
> - "type": Job type (json-string; "stream" for image streaming
> "commit" for block commit)
> -- "device": Device name (json-string)
> +- "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.
> diff --git a/qapi/block-core.json b/qapi/block-core.json
> index f754c29..5a91bc6 100644
> --- a/qapi/block-core.json
> +++ 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
> #
> @@ -1469,7 +1470,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.
Considering you put a full stop after "the job identifier", I'd
capitalize "the" (same in all following cases).
With that fixed:
Reviewed-by: Max Reitz <address@hidden>
> #
> # @speed: the maximum speed, in bytes per second, or 0 for unlimited.
> # Defaults to 0.
> @@ -1500,7 +1503,9 @@
> # operation can be started at a later time to finish copying all data from
> the
> # backing file.
> #
> -# @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.
> #
> # @force: #optional whether to allow cancellation of a paused job (default
> # false). Since 1.3.
> @@ -1526,7 +1531,9 @@
> # the operation is actually paused. Cancelling a paused job automatically
> # resumes it.
> #
> -# @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.
> #
> # Returns: Nothing on success
> # If no background operation is active on this device,
> DeviceNotActive
> @@ -1546,7 +1553,9 @@
> #
> # This command also clears the error status of the job.
> #
> -# @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.
> #
> # Returns: Nothing on success
> # If no background operation is active on this device,
> DeviceNotActive
> @@ -1572,7 +1581,9 @@
> #
> # A cancelled or paused job cannot be completed.
> #
> -# @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.
> #
> # Returns: Nothing on success
> # If no background operation is active on this device,
> DeviceNotActive
> @@ -2417,7 +2428,8 @@
> #
> # @type: job type
> #
> -# @device: device name
> +# @device: the job identifier. Originally the device name but other
> +# values are allowed since QEMU 2.7
> #
> # @len: maximum progress value
> #
> @@ -2448,7 +2460,8 @@
> #
> # @type: job type
> #
> -# @device: device name
> +# @device: the job identifier. Originally the device name but other
> +# values are allowed since QEMU 2.7
> #
> # @len: maximum progress value
> #
> @@ -2471,7 +2484,8 @@
> #
> # Emitted when a block job encounters an error
> #
> -# @device: device name
> +# @device: the job identifier. Originally the device name but other
> +# values are allowed since QEMU 2.7
> #
> # @operation: I/O operation
> #
> @@ -2491,7 +2505,8 @@
> #
> # @type: job type
> #
> -# @device: device name
> +# @device: the job identifier. Originally the device name but other
> +# values are allowed since QEMU 2.7
> #
> # @len: maximum progress value
> #
>
signature.asc
Description: OpenPGP digital signature
- [Qemu-block] [PATCH v3 01/11] stream: Fix prototype of stream_start(), (continued)
- [Qemu-block] [PATCH v3 11/11] blockjob: Update description of the 'device' field in the QMP API, Alberto Garcia, 2016/07/01
- Re: [Qemu-block] [PATCH v3 11/11] blockjob: Update description of the 'device' field in the QMP API,
Max Reitz <=
- [Qemu-block] [PATCH v3 03/11] blockjob: Add block_job_get(), Alberto Garcia, 2016/07/01
- [Qemu-block] [PATCH v3 08/11] stream: Add 'job-id' parameter to 'block-stream', Alberto Garcia, 2016/07/01
- [Qemu-block] [PATCH v3 07/11] backup: Add 'job-id' parameter to 'blockdev-backup' and 'drive-backup', Alberto Garcia, 2016/07/01
- [Qemu-block] [PATCH v3 06/11] mirror: Add 'job-id' parameter to 'blockdev-mirror' and 'drive-mirror', Alberto Garcia, 2016/07/01
- Re: [Qemu-block] [PATCH v3 00/11] Allow creating block jobs with a user-defined ID, Kevin Wolf, 2016/07/04