qapi: generalize documentation of streaming commands

Talk about background operations in general, rather than specifically
about streaming.

Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
This commit is contained in:
Paolo Bonzini 2012-07-24 13:03:39 +02:00 committed by Kevin Wolf
parent b2df431407
commit 05290d80c8
2 changed files with 9 additions and 10 deletions

View File

@ -101,7 +101,7 @@ ETEXI
.name = "block_job_cancel", .name = "block_job_cancel",
.args_type = "device:B", .args_type = "device:B",
.params = "device", .params = "device",
.help = "stop an active block streaming operation", .help = "stop an active background block operation",
.mhandler.cmd = hmp_block_job_cancel, .mhandler.cmd = hmp_block_job_cancel,
}, },

View File

@ -1660,7 +1660,7 @@
# Returns: Nothing on success # Returns: Nothing on success
# If the job type does not support throttling, NotSupported # If the job type does not support throttling, NotSupported
# If the speed value is invalid, InvalidParameter # If the speed value is invalid, InvalidParameter
# If streaming is not active on this device, DeviceNotActive # If no background operation is active on this device, DeviceNotActive
# #
# Since: 1.1 # Since: 1.1
## ##
@ -1670,9 +1670,9 @@
## ##
# @block-job-cancel: # @block-job-cancel:
# #
# Stop an active block streaming operation. # Stop an active background block operation.
# #
# This command returns immediately after marking the active block streaming # This command returns immediately after marking the active background block
# operation for cancellation. It is an error to call this command if no # operation for cancellation. It is an error to call this command if no
# operation is in progress. # operation is in progress.
# #
@ -1680,16 +1680,15 @@
# BLOCK_JOB_CANCELLED event. Before that happens the job is still visible when # BLOCK_JOB_CANCELLED event. Before that happens the job is still visible when
# enumerated using query-block-jobs. # enumerated using query-block-jobs.
# #
# The image file retains its backing file unless the streaming operation happens # For streaming, the image file retains its backing file unless the streaming
# to complete just as it is being cancelled. # operation happens to complete just as it is being cancelled. A new streaming
# # operation can be started at a later time to finish copying all data from the
# A new block streaming operation can be started at a later time to finish # backing file.
# copying all data from the backing file.
# #
# @device: the device name # @device: the device name
# #
# Returns: Nothing on success # Returns: Nothing on success
# If streaming is not active on this device, DeviceNotActive # If no background operation is active on this device, DeviceNotActive
# If cancellation already in progress, DeviceInUse # If cancellation already in progress, DeviceInUse
# #
# Since: 1.1 # Since: 1.1