[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [RFC PATCH 01/36] qapi: generalize documentation of streami
From: |
Paolo Bonzini |
Subject: |
[Qemu-devel] [RFC PATCH 01/36] qapi: generalize documentation of streaming commands |
Date: |
Fri, 15 Jun 2012 17:05:24 +0200 |
Talk about background operations in general, rather than specifically
about streaming.
Signed-off-by: Paolo Bonzini <address@hidden>
---
hmp-commands.hx | 2 +-
qapi-schema.json | 17 ++++++++---------
2 files changed, 9 insertions(+), 10 deletions(-)
diff --git a/hmp-commands.hx b/hmp-commands.hx
index f5d9d91..26a4d8d 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 3b6e346..eca0872 100644
--- a/qapi-schema.json
+++ b/qapi-schema.json
@@ -1651,7 +1651,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
##
@@ -1661,9 +1661,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.
#
@@ -1671,16 +1671,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
--
1.7.10.2
- [Qemu-devel] [RFC PATCH 00/36] A peek at the current block job patches, Paolo Bonzini, 2012/06/15
- [Qemu-devel] [RFC PATCH 01/36] qapi: generalize documentation of streaming commands,
Paolo Bonzini <=
- [Qemu-devel] [RFC PATCH 02/36] qerror/block: introduce QERR_BLOCK_JOB_NOT_ACTIVE, Paolo Bonzini, 2012/06/15
- [Qemu-devel] [RFC PATCH 04/36] block: add block_job_query, Paolo Bonzini, 2012/06/15
- [Qemu-devel] [RFC PATCH 03/36] block: move job APIs to separate files, Paolo Bonzini, 2012/06/15
- [Qemu-devel] [RFC PATCH 06/36] qmp: add block-job-pause and block-job-resume, Paolo Bonzini, 2012/06/15
- [Qemu-devel] [RFC PATCH 05/36] block: add support for job pause/resume, Paolo Bonzini, 2012/06/15