diff options
| author | Paolo Bonzini <pbonzini@redhat.com> | 2012-07-24 13:03:39 +0200 |
|---|---|---|
| committer | Kevin Wolf <kwolf@redhat.com> | 2012-08-06 22:39:14 +0200 |
| commit | 05290d80c88de1e4d02f2f00605e09206430cca9 (patch) | |
| tree | 89a4a2ae1c5d219221df05b3e06e284b0814d70c | |
| parent | b2df431407a099ad2fe87a76188d12d99ab12841 (diff) | |
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>
| -rw-r--r-- | hmp-commands.hx | 2 | ||||
| -rw-r--r-- | qapi-schema.json | 17 |
2 files changed, 9 insertions, 10 deletions
diff --git a/hmp-commands.hx b/hmp-commands.hx index eea8b32894..9bbc7f7555 100644 --- a/hmp-commands.hx +++ b/hmp-commands.hx @@ -101,7 +101,7 @@ ETEXI .name = "block_job_cancel", .args_type = "device:B", .params = "device", - .help = "stop an active block streaming operation", + .help = "stop an active background block operation", .mhandler.cmd = hmp_block_job_cancel, }, diff --git a/qapi-schema.json b/qapi-schema.json index cddf63a878..bd9c450029 100644 --- a/qapi-schema.json +++ b/qapi-schema.json @@ -1660,7 +1660,7 @@ # Returns: Nothing on success # If the job type does not support throttling, NotSupported # 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 ## @@ -1670,9 +1670,9 @@ ## # @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 is in progress. # @@ -1680,16 +1680,15 @@ # BLOCK_JOB_CANCELLED event. Before that happens the job is still visible when # enumerated using query-block-jobs. # -# The image file retains its backing file unless the streaming operation happens -# to complete just as it is being cancelled. -# -# A new block streaming operation can be started at a later time to finish -# copying all data from the backing file. +# For streaming, the image file retains its backing file unless the streaming +# 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 +# backing file. # # @device: the device name # # 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 # # Since: 1.1 |