qemu-e2k/docs
Kashyap Chamarthy c117bb14ff QAPI & interop: Clarify events emitted by 'block-job-cancel'
When you cancel an in-progress 'mirror' job (or "active `block-commit`")
with QMP `block-job-cancel`, it emits the event: BLOCK_JOB_CANCELLED.
However, when `block-job-cancel` is issued *after* `drive-mirror` has
indicated (via the event BLOCK_JOB_READY) that the source and
destination have reached synchronization:

    [...] # Snip `drive-mirror` invocation & outputs
    {
      "execute":"block-job-cancel",
      "arguments":{
        "device":"virtio0"
      }
    }

    {"return": {}}

It (`block-job-cancel`) will counterintuitively emit the event
'BLOCK_JOB_COMPLETED':

    {
      "timestamp":{
        "seconds":1510678024,
        "microseconds":526240
      },
      "event":"BLOCK_JOB_COMPLETED",
      "data":{
        "device":"virtio0",
        "len":41126400,
        "offset":41126400,
        "speed":0,
        "type":"mirror"
      }
    }

But this is expected behaviour, where the _COMPLETED event indicates
that synchronization has successfully ended (and the destination now has
a point-in-time copy, which is at the time of cancel).

So add a small note to this effect in 'block-core.json'.  While at it,
also update the "Live disk synchronization -- drive-mirror and
blockdev-mirror" section in 'live-block-operations.rst'.

(Thanks: Max Reitz for reminding me of this caveat on IRC.)

Signed-off-by: Kashyap Chamarthy <kchamart@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
2017-11-27 14:59:35 +01:00
..
config docs: create config/, devel/ and spin/ subdirectories 2017-06-07 18:22:03 +02:00
devel docs/devel/loads-stores.rst: Document our various load and store APIs 2017-10-16 18:03:52 +02:00
interop QAPI & interop: Clarify events emitted by 'block-job-cancel' 2017-11-27 14:59:35 +01:00
specs specs: Extend TPM spec with TPM emulator description 2017-11-15 06:47:35 -05:00
spin docs: create config/, devel/ and spin/ subdirectories 2017-06-07 18:22:03 +02:00
block-replication.txt
bootindex.txt docs qemu-doc: Avoid ide-drive, it's deprecated 2017-06-04 18:42:55 +03:00
ccid.txt
COLO-FT.txt
colo-proxy.txt colo-compare: Update the COLO document to add the IOThread configuration 2017-09-08 09:34:40 +08:00
generic-loader.txt
igd-assign.txt
image-fuzzer.txt
memory-hotplug.txt trivial: Add missing "-m" parameter in docs/memory-hotplug.txt 2017-09-26 09:11:22 +03:00
multi-thread-compression.txt
multiseat.txt
nvdimm.txt
pci_expander_bridge.txt
pcie_pci_bridge.txt docs: update documentation considering PCIE-PCI bridge 2017-09-08 16:15:17 +03:00
pcie.txt Use HTTPS for qemu.org and other domains 2017-11-21 13:34:13 +00:00
pr-manager.rst scsi: add multipath support to qemu-pr-helper 2017-09-22 21:07:27 +02:00
qcow2-cache.txt docs: fix broken paths to docs/interop/qcow2.txt 2017-07-31 13:12:35 +03:00
qdev-device-use.txt pci-assign: Remove 2017-11-05 14:52:10 +01:00
qemu_logo.pdf
qemu-block-drivers.texi docs: Add image locking subsection 2017-11-27 11:25:41 +01:00
qemupciserial.inf
rdma.txt Use HTTPS for qemu.org and other domains 2017-11-21 13:34:13 +00:00
replay.txt replay: add record/replay for audio passthrough 2017-03-01 15:11:44 +01:00
spice-port-fqdn.txt
throttle.txt
usb2.txt docs: fix broken paths to docs/config/ich9-ehci-uhci.cfg 2017-07-31 13:12:55 +03:00
usb-storage.txt
virtio-balloon-stats.txt
xbzrle.txt
xen-save-devices-state.txt