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

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

[Fam Zheng]

Signed-off-by: Fam Zheng <famz@redhat.com>

---

v3: Document that the option is not allowed for read-write. [Stefan]

v2: - "code{qemu-img}". [Kashyap, Eric]
    - "etc.." -> "etc.".
---
 qemu-img.texi | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/qemu-img.texi b/qemu-img.texi
index fdcf120f36..d85ace73f0 100644
--- a/qemu-img.texi
+++ b/qemu-img.texi
@@ -57,6 +57,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 result because of concurrent metadata changes,
+etc. This option is only allowed when opening image in read-only mode.
+
 @item fmt
 is the disk image format. It is guessed automatically in most cases. See below
 for a description of the supported disk formats.
-- 
2.14.3

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

[Kevin Wolf]

Am 11.12.2017 um 10:33 hat Fam Zheng geschrieben:
> Signed-off-by: Fam Zheng <famz@redhat.com>
> 
> ---
> 
> v3: Document that the option is not allowed for read-write. [Stefan]
> 
> v2: - "code{qemu-img}". [Kashyap, Eric]
>     - "etc.." -> "etc.".
> ---
>  qemu-img.texi | 9 +++++++++
>  1 file changed, 9 insertions(+)
> 
> diff --git a/qemu-img.texi b/qemu-img.texi
> index fdcf120f36..d85ace73f0 100644
> --- a/qemu-img.texi
> +++ b/qemu-img.texi
> @@ -57,6 +57,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 result because of concurrent metadata changes,
> +etc. This option is only allowed when opening image in read-only mode.

I think "an image", "the image" or "images" could all work in this
context, but just "image" without an article doesn't.

Kevin

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

[Fam Zheng]

On Mon, 12/11 10:50, Kevin Wolf wrote:
> Am 11.12.2017 um 10:33 hat Fam Zheng geschrieben:
> > Signed-off-by: Fam Zheng <famz@redhat.com>
> > 
> > ---
> > 
> > v3: Document that the option is not allowed for read-write. [Stefan]
> > 
> > v2: - "code{qemu-img}". [Kashyap, Eric]
> >     - "etc.." -> "etc.".
> > ---
> >  qemu-img.texi | 9 +++++++++
> >  1 file changed, 9 insertions(+)
> > 
> > diff --git a/qemu-img.texi b/qemu-img.texi
> > index fdcf120f36..d85ace73f0 100644
> > --- a/qemu-img.texi
> > +++ b/qemu-img.texi
> > @@ -57,6 +57,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 result because of concurrent metadata changes,
> > +etc. This option is only allowed when opening image in read-only mode.
> 
> I think "an image", "the image" or "images" could all work in this
> context, but just "image" without an article doesn't.

"Images" would be my intent if I proofread it, but you're right, all sound okay
to me. Thanks.

Fam