Re: [Qemu-devel] [RFC PATCH 01/36] qapi: generalize documentation of streaming commands

[Eric Blake]

On 06/15/2012 09:05 AM, Paolo Bonzini wrote:
> 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",

Reviewed-by: Eric Blake <address@hidden>

>  #
> -# 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

Pre-existing, but do we have any policy on US (canceled) vs. UK
(cancelled) spelling?  Obviously, our API spelling is locked into UK
spelling, but if the docs generally prefer US spelling, do we need to
adjust things here?  But any such adjustments should be separate
commits, so no impact to my reviewed-by.

-- 
Eric Blake   address@hidden    +1-919-301-3266
Libvirt virtualization library http://libvirt.org

signature.asc
Description: OpenPGP digital signature