Re: [Qemu-devel] [PATCH v2 6/7] qemu-img: clean up dd documentation

[Eric Blake]

On 08/26/2016 04:16 AM, Reda Sallahi wrote:
> The dd section on qemu-img --help was a bit hard to read since it was not
> well aligned. This patch fixes the display problem and also makes the
> sentences on the .texi file more consistent with one another (uppercase and
> conjugasion).

s/conjugasion/conjugation/

> 
> Signed-off-by: Reda Sallahi <address@hidden>
> Reviewed-by: Stefan Hajnoczi <address@hidden>
> ---
>  qemu-img.c    | 48 +++++++++++++++++++++++++-----------------------
>  qemu-img.texi | 48 ++++++++++++++++++++++++------------------------
>  2 files changed, 49 insertions(+), 47 deletions(-)
> 


>             "List of LEVELS for dd:\n"
> -           "  'none'   surpresses everything but error messages\n"
> -           "  'noxfer' surpresses the final transfer statistics\n\n"
> +           "  'none'         surpress everything but error messages\n"
> +           "  'noxfer'       surpress the final transfer statistics\n\n"

s/surpress/suppress/ (twice)

> +           "  'fsync'        physically write output file data before"
> +           " finishing\n"
> +           "  'fdatasync'    physically write output file data before"
> +           " finishing\n"

What's the difference between these two? (fdatasync only flushes file
data, while fsync flushes ALL file metadata and is thus stronger. But
using the same wording for both lines doesn't make it obvious which one
is stronger, and I shouldn't have to resort to 'man fdatasync' to learn
the difference).


>  @item fdatasync
> -Synchronize output data just before finishing. This forces a physical write 
> of output data.
> +Synchronizes output data just before finishing. This forces a physical write 
> of output data.
>  @item fsync
> -Synchronize output data just before finishing. This forces a physical write 
> of output data.
> +Synchronizes output data just before finishing. This forces a physical write 
> of output data.

Again, mention which version is stronger.

>  @item excl
> -Err if the output file already exists.
> +Errs if the output file already exists.

s/Errs/Raises an error/

>  @item nocreat
> -Do not create the output file; the output file must already exist.
> +Does not create the output file; the output file must already exist.
>  @item sparse
> -Seek rather than write NUL output blocks.
> +Seeks rather than write NUL output blocks.
>  
>  @item address@hidden
> -defines the flags used to read the input file. The flag list is seprated 
> using
> +Defines the flags used to read the input file. The flag list is seprated 
> using

s/seprated/separated/

>  commas.
>  @item address@hidden
> -defines the flags used to write the output file. The flag list is seprated
> +Defines the flags used to write the output file. The flag list is seprated

and again

>  using commas.
>  
>  The flag list:
>  @item direct
> -direct I/O for data.
> +Direct I/O for data.
>  @item dsync
> -synchronised I/O for data.
> +Synchronised I/O for data.

Do we have a strong preference for US (-ized) vs. UK (-ised) spelling
elsewhere in this document?

-- 
Eric Blake   eblake redhat com    +1-919-301-3266
Libvirt virtualization library http://libvirt.org

signature.asc
Description: OpenPGP digital signature