From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([208.118.235.92]:60066) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1SyUAe-0008BX-AJ for qemu-devel@nongnu.org; Mon, 06 Aug 2012 16:45:01 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1SyUAd-0004Nk-4V for qemu-devel@nongnu.org; Mon, 06 Aug 2012 16:45:00 -0400 Received: from mx1.redhat.com ([209.132.183.28]:24816) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1SyUAc-0004NV-RZ for qemu-devel@nongnu.org; Mon, 06 Aug 2012 16:44:59 -0400 From: Kevin Wolf Date: Mon, 6 Aug 2012 22:44:41 +0200 Message-Id: <1344285891-6578-3-git-send-email-kwolf@redhat.com> In-Reply-To: <1344285891-6578-1-git-send-email-kwolf@redhat.com> References: <1344285891-6578-1-git-send-email-kwolf@redhat.com> Subject: [Qemu-devel] [PATCH 02/12] qapi: generalize documentation of streaming commands List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: anthony@codemonkey.ws Cc: kwolf@redhat.com, qemu-devel@nongnu.org From: Paolo Bonzini Talk about background operations in general, rather than specifically about streaming. Signed-off-by: Paolo Bonzini Signed-off-by: Kevin Wolf --- 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 cddf63a..bd9c450 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 -- 1.7.6.5