From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([208.118.235.92]:46961) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Stcuz-0004rd-35 for qemu-devel@nongnu.org; Tue, 24 Jul 2012 07:04:50 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1Stcut-00057n-OF for qemu-devel@nongnu.org; Tue, 24 Jul 2012 07:04:45 -0400 Received: from mail-gg0-f173.google.com ([209.85.161.173]:59954) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Stcut-00057c-KE for qemu-devel@nongnu.org; Tue, 24 Jul 2012 07:04:39 -0400 Received: by ggnp1 with SMTP id p1so6578762ggn.4 for ; Tue, 24 Jul 2012 04:04:39 -0700 (PDT) Sender: Paolo Bonzini From: Paolo Bonzini Date: Tue, 24 Jul 2012 13:03:39 +0200 Message-Id: <1343127865-16608-2-git-send-email-pbonzini@redhat.com> In-Reply-To: <1343127865-16608-1-git-send-email-pbonzini@redhat.com> References: <1343127865-16608-1-git-send-email-pbonzini@redhat.com> Subject: [Qemu-devel] [PATCH 01/47] qapi: generalize documentation of streaming commands List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: qemu-devel@nongnu.org Cc: kwolf@redhat.com, jcody@redhat.com, eblake@redhat.com, stefanha@linux.vnet.ibm.com Talk about background operations in general, rather than specifically about streaming. Signed-off-by: Paolo Bonzini --- 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 eea8b32..9bbc7f7 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 bc55ed2..000eb83 100644 --- a/qapi-schema.json +++ b/qapi-schema.json @@ -1657,7 +1657,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 ## @@ -1667,9 +1667,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. # @@ -1677,16 +1677,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.4