[Qemu-devel] [PATCH v5 0/2] qemu-img: Document --force-share / -U

[Qemu-devel] [PATCH v5 0/2] qemu-img: Document --force-share / -U

[Fam Zheng]

v5: Clean up the @table @var section first. [Kevin, Peter]

Fam Zheng (2):
  qemu-img.texi: Clean up parameter list
  qemu-img: Document --force-share / -U

 qemu-img.texi | 75 ++++++++++++++++++++++++++++++++++++++---------------------
 1 file changed, 48 insertions(+), 27 deletions(-)

-- 
2.14.3

[Qemu-devel] [PATCH v5 1/2] qemu-img.texi: Clean up parameter list

[Fam Zheng]

Split options out of the "@table @var" section and create a "@table
@option", then use whitespaces and blank lines consistently.

Suggested-by: Kevin Wolf <kwolf@redhat.com>
Signed-off-by: Fam Zheng <famz@redhat.com>
---
 qemu-img.texi | 66 +++++++++++++++++++++++++++++++++++------------------------
 1 file changed, 39 insertions(+), 27 deletions(-)

diff --git a/qemu-img.texi b/qemu-img.texi
index fdcf120f36..60a0e080c6 100644
--- a/qemu-img.texi
+++ b/qemu-img.texi
@@ -33,38 +33,14 @@ The following commands are supported:
 
 Command parameters:
 @table @var
+
 @item filename
- is a disk image filename
-
-@item --object @var{objectdef}
-
-is a QEMU user creatable object definition. See the @code{qemu(1)} manual
-page for a description of the object properties. The most common object
-type is a @code{secret}, which is used to supply passwords and/or encryption
-keys.
-
-@item --image-opts
-
-Indicates that the source @var{filename} parameter is to be interpreted as a
-full option string, not a plain filename. This parameter is mutually
-exclusive with the @var{-f} parameter.
-
-@item --target-image-opts
-
-Indicates that the @var{output_filename} parameter(s) are to be interpreted as
-a full option string, not a plain filename. This parameter is mutually
-exclusive with the @var{-O} parameters. It is currently required to also use
-the @var{-n} parameter to skip image creation. This restriction may be relaxed
-in a future release.
+is a disk image filename
 
 @item fmt
 is the disk image format. It is guessed automatically in most cases. See below
 for a description of the supported disk formats.
 
-@item --backing-chain
-will enumerate information about backing files in a disk image chain. Refer
-below for further description.
-
 @item size
 is the disk image size in bytes. Optional suffixes @code{k} or @code{K}
 (kilobyte, 1024) @code{M} (megabyte, 1024k) and @code{G} (gigabyte, 1024M)
@@ -74,42 +50,78 @@ and T (terabyte, 1024G) are supported.  @code{b} is ignored.
 is the destination disk image filename
 
 @item output_fmt
- is the destination format
+is the destination format
+
 @item options
 is a comma separated list of format specific options in a
 name=value format. Use @code{-o ?} for an overview of the options supported
 by the used format or see the format descriptions below for details.
+
 @item snapshot_param
 is param used for internal snapshot, format is
 'snapshot.id=[ID],snapshot.name=[NAME]' or '[ID_OR_NAME]'
+
 @item snapshot_id_or_name
 is deprecated, use snapshot_param instead
 
+@end table
+
+@table @option
+
+@item --object @var{objectdef}
+is a QEMU user creatable object definition. See the @code{qemu(1)} manual
+page for a description of the object properties. The most common object
+type is a @code{secret}, which is used to supply passwords and/or encryption
+keys.
+
+@item --image-opts
+Indicates that the source @var{filename} parameter is to be interpreted as a
+full option string, not a plain filename. This parameter is mutually
+exclusive with the @var{-f} parameter.
+
+@item --target-image-opts
+Indicates that the @var{output_filename} parameter(s) are to be interpreted as
+a full option string, not a plain filename. This parameter is mutually
+exclusive with the @var{-O} parameters. It is currently required to also use
+the @var{-n} parameter to skip image creation. This restriction may be relaxed
+in a future release.
+
+@item --backing-chain
+will enumerate information about backing files in a disk image chain. Refer
+below for further description.
+
 @item -c
 indicates that target image must be compressed (qcow format only)
+
 @item -h
 with or without a command shows help and lists the supported formats
+
 @item -p
 display progress bar (compare, convert and rebase commands only).
 If the @var{-p} option is not used for a command that supports it, the
 progress is reported when the process receives a @code{SIGUSR1} or
 @code{SIGINFO} signal.
+
 @item -q
 Quiet mode - do not print any output (except errors). There's no progress bar
 in case both @var{-q} and @var{-p} options are used.
+
 @item -S @var{size}
 indicates the consecutive number of bytes that must contain only zeros
 for qemu-img to create a sparse image during conversion. This value is rounded
 down to the nearest 512 bytes. You may use the common size suffixes like
 @code{k} for kilobytes.
+
 @item -t @var{cache}
 specifies the cache mode that should be used with the (destination) file. See
 the documentation of the emulator's @code{-drive cache=...} option for allowed
 values.
+
 @item -T @var{src_cache}
 specifies the cache mode that should be used with the source file(s). See
 the documentation of the emulator's @code{-drive cache=...} option for allowed
 values.
+
 @end table
 
 Parameters to snapshot subcommand:
-- 
2.14.3

Re: [Qemu-devel] [PATCH v5 1/2] qemu-img.texi: Clean up parameter list

[Eric Blake]

[-- Attachment #1: Type: text/plain, Size: 597 bytes --]

On 12/25/2017 08:52 PM, Fam Zheng wrote:
> Split options out of the "@table @var" section and create a "@table
> @option", then use whitespaces and blank lines consistently.
> 
> Suggested-by: Kevin Wolf <kwolf@redhat.com>
> Signed-off-by: Fam Zheng <famz@redhat.com>
> ---
>  qemu-img.texi | 66 +++++++++++++++++++++++++++++++++++------------------------
>  1 file changed, 39 insertions(+), 27 deletions(-)

Reviewed-by: Eric Blake <eblake@redhat.com>

-- 
Eric Blake, Principal Software Engineer
Red Hat, Inc.           +1-919-301-3266
Virtualization:  qemu.org | libvirt.org


[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 619 bytes --]

Re: [Qemu-devel] [PATCH v5 1/2] qemu-img.texi: Clean up parameter list

[Kashyap Chamarthy]

On Tue, Dec 26, 2017 at 10:52:46AM +0800, Fam Zheng wrote:
> Split options out of the "@table @var" section and create a "@table
> @option", then use whitespaces and blank lines consistently.
> 
> Suggested-by: Kevin Wolf <kwolf@redhat.com>
> Signed-off-by: Fam Zheng <famz@redhat.com>
> ---
>  qemu-img.texi | 66 +++++++++++++++++++++++++++++++++++------------------------
>  1 file changed, 39 insertions(+), 27 deletions(-)

Reviewed-by: Kashyap Chamarthy <kchamart@redhat.com>

[...]

-- 
/kashyap

[Qemu-devel] [PATCH v5 2/2] qemu-img: Document --force-share / -U

[Fam Zheng]

Signed-off-by: Fam Zheng <famz@redhat.com>
Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>
Reviewed-by: Kashyap Chamarthy <kchamart@redhat.com>
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
---
 qemu-img.texi | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/qemu-img.texi b/qemu-img.texi
index 60a0e080c6..e83e140f7a 100644
--- a/qemu-img.texi
+++ b/qemu-img.texi
@@ -86,6 +86,15 @@ exclusive with the @var{-O} parameters. It is currently required to also use
 the @var{-n} parameter to skip image creation. This restriction may be relaxed
 in a future release.
 
+@item --force-share (-U)
+
+If specified, @code{qemu-img} will open the image with shared permissions,
+which makes it less likely to conflict with a running guest's permissions due
+to image locking. For example, this can be used to get the image information
+(with 'info' subcommand) when the image is used by a running guest. Note that
+this could produce inconsistent results because of concurrent metadata changes,
+etc. This option is only allowed when opening images in read-only mode.
+
 @item --backing-chain
 will enumerate information about backing files in a disk image chain. Refer
 below for further description.
-- 
2.14.3

Re: [Qemu-devel] [PATCH v5 2/2] qemu-img: Document --force-share / -U

[Max Reitz]

[-- Attachment #1: Type: text/plain, Size: 2001 bytes --]

On 2017-12-26 03:52, Fam Zheng wrote:
> Signed-off-by: Fam Zheng <famz@redhat.com>
> Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>
> Reviewed-by: Kashyap Chamarthy <kchamart@redhat.com>
> Signed-off-by: Kevin Wolf <kwolf@redhat.com>
> ---
>  qemu-img.texi | 9 +++++++++
>  1 file changed, 9 insertions(+)
> 
> diff --git a/qemu-img.texi b/qemu-img.texi
> index 60a0e080c6..e83e140f7a 100644
> --- a/qemu-img.texi
> +++ b/qemu-img.texi
> @@ -86,6 +86,15 @@ exclusive with the @var{-O} parameters. It is currently required to also use
>  the @var{-n} parameter to skip image creation. This restriction may be relaxed
>  in a future release.
>  
> +@item --force-share (-U)
> +

So the previous patch makes the use of blank lines consistent and this
one breaks it again? :-)

> +If specified, @code{qemu-img} will open the image with shared permissions,
> +which makes it less likely to conflict with a running guest's permissions due
> +to image locking. For example, this can be used to get the image information
> +(with 'info' subcommand) when the image is used by a running guest. Note that
> +this could produce inconsistent results because of concurrent metadata changes,
> +etc. This option is only allowed when opening images in read-only mode.

I personally don't quite like the "makes it less likely to conflict",
because that makes it sound like qemu would be stupid and need a nudge
in the right direction -- when it's actually the user who does something
a bit risky (and qemu is right in forbidding it by default).  But since
it's only a read-only thing, I won't actually object to it.

(Maybe it should document more exactly what's happening, i.e. that this
option will allow concurrent writers (as a standard user, I wouldn't
know what "shared permissions" is supposed to mean).)

Max

> +
>  @item --backing-chain
>  will enumerate information about backing files in a disk image chain. Refer
>  below for further description.
> 



[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 512 bytes --]

Re: [Qemu-devel] [PATCH v5 2/2] qemu-img: Document --force-share / -U

[Kashyap Chamarthy]

On Mon, Jan 29, 2018 at 05:01:41PM +0100, Max Reitz wrote:
> On 2017-12-26 03:52, Fam Zheng wrote:

[...]

> So the previous patch makes the use of blank lines consistent and this
> one breaks it again? :-)
> 
> > +If specified, @code{qemu-img} will open the image with shared permissions,
> > +which makes it less likely to conflict with a running guest's permissions due
> > +to image locking. For example, this can be used to get the image information
> > +(with 'info' subcommand) when the image is used by a running guest. Note that
> > +this could produce inconsistent results because of concurrent metadata changes,
> > +etc. This option is only allowed when opening images in read-only mode.
> 
> I personally don't quite like the "makes it less likely to conflict",
> because that makes it sound like qemu would be stupid and need a nudge
> in the right direction -- when it's actually the user who does something
> a bit risky (and qemu is right in forbidding it by default).  But since
> it's only a read-only thing, I won't actually object to it.
> 
> (Maybe it should document more exactly what's happening, i.e. that this
> option will allow concurrent writers (as a standard user, I wouldn't
> know what "shared permissions" is supposed to mean).)

Eerie -- Although I reviewed it, I was just mulling over this wording
yesterday (while I was tweaking the wording of '--force-share' on a
slide for a public conference).  

Indeed, "concurrent writers" is much clearer.


[...]


-- 
/kashyap

Re: [Qemu-devel] [PATCH v5 2/2] qemu-img: Document --force-share / -U

[Fam Zheng]

On Tue, Jan 30, 2018 at 12:01 AM, Max Reitz <mreitz@redhat.com> wrote:
> On 2017-12-26 03:52, Fam Zheng wrote:
>> Signed-off-by: Fam Zheng <famz@redhat.com>
>> Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>
>> Reviewed-by: Kashyap Chamarthy <kchamart@redhat.com>
>> Signed-off-by: Kevin Wolf <kwolf@redhat.com>
>> ---
>>  qemu-img.texi | 9 +++++++++
>>  1 file changed, 9 insertions(+)
>>
>> diff --git a/qemu-img.texi b/qemu-img.texi
>> index 60a0e080c6..e83e140f7a 100644
>> --- a/qemu-img.texi
>> +++ b/qemu-img.texi
>> @@ -86,6 +86,15 @@ exclusive with the @var{-O} parameters. It is currently required to also use
>>  the @var{-n} parameter to skip image creation. This restriction may be relaxed
>>  in a future release.
>>
>> +@item --force-share (-U)
>> +
>
> So the previous patch makes the use of blank lines consistent and this
> one breaks it again? :-)

Good point, will fix.

>
>> +If specified, @code{qemu-img} will open the image with shared permissions,
>> +which makes it less likely to conflict with a running guest's permissions due
>> +to image locking. For example, this can be used to get the image information
>> +(with 'info' subcommand) when the image is used by a running guest. Note that
>> +this could produce inconsistent results because of concurrent metadata changes,
>> +etc. This option is only allowed when opening images in read-only mode.
>
> I personally don't quite like the "makes it less likely to conflict",
> because that makes it sound like qemu would be stupid and need a nudge
> in the right direction -- when it's actually the user who does something
> a bit risky (and qemu is right in forbidding it by default).  But since
> it's only a read-only thing, I won't actually object to it.
>
> (Maybe it should document more exactly what's happening, i.e. that this
> option will allow concurrent writers (as a standard user, I wouldn't
> know what "shared permissions" is supposed to mean).)

Makes sense to me. Sending v6.

Fam

Re: [Qemu-devel] [PATCH v5 0/2] qemu-img: Document --force-share / -U

[Stefan Hajnoczi]

[-- Attachment #1: Type: text/plain, Size: 451 bytes --]

On Tue, Dec 26, 2017 at 10:52:45AM +0800, Fam Zheng wrote:
> v5: Clean up the @table @var section first. [Kevin, Peter]
> 
> Fam Zheng (2):
>   qemu-img.texi: Clean up parameter list
>   qemu-img: Document --force-share / -U
> 
>  qemu-img.texi | 75 ++++++++++++++++++++++++++++++++++++++---------------------
>  1 file changed, 48 insertions(+), 27 deletions(-)
> 
> -- 
> 2.14.3
> 

Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 455 bytes --]

Re: [Qemu-devel] [PATCH v5 0/2] qemu-img: Document --force-share / -U

[Fam Zheng]

Ping?

On Tue, Dec 26, 2017 at 10:52 AM, Fam Zheng <famz@redhat.com> wrote:
> v5: Clean up the @table @var section first. [Kevin, Peter]
>
> Fam Zheng (2):
>   qemu-img.texi: Clean up parameter list
>   qemu-img: Document --force-share / -U
>
>  qemu-img.texi | 75 ++++++++++++++++++++++++++++++++++++++---------------------
>  1 file changed, 48 insertions(+), 27 deletions(-)
>
> --
> 2.14.3
>
>

Re: [Qemu-devel] [PATCH v5 0/2] qemu-img: Document --force-share / -U

[Kashyap Chamarthy]

On Tue, Dec 26, 2017 at 10:52:45AM +0800, Fam Zheng wrote:
> v5: Clean up the @table @var section first. [Kevin, Peter]
> 
> Fam Zheng (2):
>   qemu-img.texi: Clean up parameter list
>   qemu-img: Document --force-share / -U

Reviewed-by: Kashyap Chamarthy <kchamart@redhat.com>

This documentation patch should really be merged, as the '--force-share'
was not at all documented when it was released in QEMU 2.10.

> 2.14.3
> 

-- 
/kashyap