From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([2001:4830:134:3::10]:47844) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bJM3Y-0002fj-HT for qemu-devel@nongnu.org; Sat, 02 Jul 2016 10:38:05 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1bJM3W-0005uR-9l for qemu-devel@nongnu.org; Sat, 02 Jul 2016 10:38:03 -0400 References: From: Max Reitz Message-ID: Date: Sat, 2 Jul 2016 16:37:51 +0200 MIME-Version: 1.0 In-Reply-To: Content-Type: multipart/signed; micalg=pgp-sha256; protocol="application/pgp-signature"; boundary="cAHgL67aLrMHtMqVN3gdfNmbKlWaH7tft" Subject: Re: [Qemu-devel] [PATCH v3 11/11] blockjob: Update description of the 'device' field in the QMP API List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: Alberto Garcia , qemu-devel@nongnu.org Cc: qemu-block@nongnu.org, Kevin Wolf , Eric Blake , Jeff Cody , John Snow This is an OpenPGP/MIME signed message (RFC 4880 and 3156) --cAHgL67aLrMHtMqVN3gdfNmbKlWaH7tft From: Max Reitz To: Alberto Garcia , qemu-devel@nongnu.org Cc: qemu-block@nongnu.org, Kevin Wolf , Eric Blake , Jeff Cody , John Snow Message-ID: Subject: Re: [PATCH v3 11/11] blockjob: Update description of the 'device' field in the QMP API References: In-Reply-To: Content-Type: text/plain; charset=iso-8859-15 Content-Transfer-Encoding: quoted-printable 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. >=20 > Signed-off-by: Alberto Garcia > --- > docs/qmp-events.txt | 12 ++++++++---- > qapi/block-core.json | 35 +++++++++++++++++++++++++---------- > 2 files changed, 33 insertions(+), 14 deletions(-) >=20 > 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: > =20 > - "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: > =20 > - "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. > =20 > Data: > =20 > -- "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 (jso= n-string): > "ignore": error has been ignored, the job may fail later > @@ -167,7 +170,8 @@ Data: > =20 > - "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 > # > # @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 (def= ault > # false). Since 1.3. > @@ -1526,7 +1531,9 @@ > # the operation is actually paused. Cancelling a paused job automatic= ally > # 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, Device= NotActive > @@ -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, Device= NotActive > @@ -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, Device= NotActive > @@ -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 > # >=20 --cAHgL67aLrMHtMqVN3gdfNmbKlWaH7tft Content-Type: application/pgp-signature; name="signature.asc" Content-Description: OpenPGP digital signature Content-Disposition: attachment; filename="signature.asc" -----BEGIN PGP SIGNATURE----- Version: GnuPG v2 iQEvBAEBCAAZBQJXd9G/EhxtcmVpdHpAcmVkaGF0LmNvbQAKCRA7sUIC6DisrT1r B/0VKBPDS9v4w/rVx4wsyDT5YdEg0ByORC5/44D6afoXZ0n7uRRX5FTBPMEJGlk5 W4n5lTLyiANPJeNzDOmlsGC11w0WhvsuVQ4lkhXzvFDuOgWqLLE7IC5Zc2Qbuqng mRqId+zrrTsADeNur2OXZLKwG2eKs5ikHSmtHlcFg0EEPkOPTv+HmZ1VYIYG98uJ JLgFw9KUYfCTkLc1UATcMi3KflC7vXY1d91zHINk+QeFcfKl2Dn6xAJ4V3oesRmx wBuA4r91I9PelMbb7mex/6B9+3i9Ie1cS4g0TnUQ+nIJNKUg9UnQsIQQ+SWdtqES dOTnOzr0komcviuQnFZRsuPb =YI/z -----END PGP SIGNATURE----- --cAHgL67aLrMHtMqVN3gdfNmbKlWaH7tft--