virtfs: Add missing "id" parameter in documentation
diff mbox series

Message ID 20190505144527.27926-1-thuth@redhat.com
State New
Headers show
Series
  • virtfs: Add missing "id" parameter in documentation
Related show

Commit Message

Thomas Huth May 5, 2019, 2:45 p.m. UTC
... and remove the square brackets from "path" and "security_model",
since these parameters are not optional.

Buglink: https://bugs.launchpad.net/qemu/+bug/1581976
Signed-off-by: Thomas Huth <thuth@redhat.com>
---
 qemu-options.hx | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Greg Kurz May 5, 2019, 6:32 p.m. UTC | #1
Hi Thomas,

Thanks for the janitoring :)

On Sun,  5 May 2019 16:45:27 +0200
Thomas Huth <thuth@redhat.com> wrote:

> ... and remove the square brackets from "path" and "security_model",
> since these parameters are not optional.
> 

Well this is only true when fsdriver == local, but the other fs drivers,
ie. proxy and synth, don't need it at all. Each driver has its own set of
options actually. This should better be described with separate lines IMHO.

Also, it should be stated that "id" relates to the fs backend, ie. it
belongs to the -fsdev "id" space, not to the device that gets exposed
to the guest.

Cheers,

--
Greg

> Buglink: https://bugs.launchpad.net/qemu/+bug/1581976
> Signed-off-by: Thomas Huth <thuth@redhat.com>
> ---
>  qemu-options.hx | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/qemu-options.hx b/qemu-options.hx
> index 51802cbb26..9571ddd141 100644
> --- a/qemu-options.hx
> +++ b/qemu-options.hx
> @@ -1311,7 +1311,7 @@ DEF("virtfs", HAS_ARG, QEMU_OPTION_virtfs,
>  
>  STEXI
>  
> -@item -virtfs @var{fsdriver}[,path=@var{path}],mount_tag=@var{mount_tag}[,security_model=@var{security_model}][,writeout=@var{writeout}][,readonly][,socket=@var{socket}|sock_fd=@var{sock_fd}][,fmode=@var{fmode}][,dmode=@var{dmode}]
> +@item -virtfs @var{fsdriver},path=@var{path},mount_tag=@var{mount_tag},security_model=@var{security_model}[,id=@var{id}][,writeout=@var{writeout}][,readonly][,socket=@var{socket}|sock_fd=@var{sock_fd}][,fmode=@var{fmode}][,dmode=@var{dmode}]
>  @findex -virtfs
>  
>  The general form of a Virtual File system pass-through options are:
Thomas Huth May 6, 2019, 3:49 a.m. UTC | #2
On 05/05/2019 20.32, Greg Kurz wrote:
> Hi Thomas,
> 
> Thanks for the janitoring :)
> 
> On Sun,  5 May 2019 16:45:27 +0200
> Thomas Huth <thuth@redhat.com> wrote:
> 
>> ... and remove the square brackets from "path" and "security_model",
>> since these parameters are not optional.
>>
> 
> Well this is only true when fsdriver == local, but the other fs drivers,
> ie. proxy and synth, don't need it at all.

Ok, then this is wrong in the output of "--help" instead.

> Each driver has its own set of
> options actually. This should better be described with separate lines IMHO.
> 
> Also, it should be stated that "id" relates to the fs backend, ie. it
> belongs to the -fsdev "id" space, not to the device that gets exposed
> to the guest.

Hmm, maybe it would be better if you do this patch, since you've
definitely got way more knowledge here than I do... Otherwise, I can
have a try, but it might take a while till I get back to this...

 Thomas
Greg Kurz May 6, 2019, 6:07 a.m. UTC | #3
On Mon, 6 May 2019 05:49:40 +0200
Thomas Huth <thuth@redhat.com> wrote:

> On 05/05/2019 20.32, Greg Kurz wrote:
> > Hi Thomas,
> > 
> > Thanks for the janitoring :)
> > 
> > On Sun,  5 May 2019 16:45:27 +0200
> > Thomas Huth <thuth@redhat.com> wrote:
> >   
> >> ... and remove the square brackets from "path" and "security_model",
> >> since these parameters are not optional.
> >>  
> > 
> > Well this is only true when fsdriver == local, but the other fs drivers,
> > ie. proxy and synth, don't need it at all.  
> 
> Ok, then this is wrong in the output of "--help" instead.
> 

Yeah, I've taken a look and both the usage and the man page need
fixing...

> > Each driver has its own set of
> > options actually. This should better be described with separate lines IMHO.
> > 
> > Also, it should be stated that "id" relates to the fs backend, ie. it
> > belongs to the -fsdev "id" space, not to the device that gets exposed
> > to the guest.  
> 
> Hmm, maybe it would be better if you do this patch, since you've
> definitely got way more knowledge here than I do... Otherwise, I can
> have a try, but it might take a while till I get back to this...
> 

Sure, I'll do that.

>  Thomas

Cheers,

--
Greg

Patch
diff mbox series

diff --git a/qemu-options.hx b/qemu-options.hx
index 51802cbb26..9571ddd141 100644
--- a/qemu-options.hx
+++ b/qemu-options.hx
@@ -1311,7 +1311,7 @@  DEF("virtfs", HAS_ARG, QEMU_OPTION_virtfs,
 
 STEXI
 
-@item -virtfs @var{fsdriver}[,path=@var{path}],mount_tag=@var{mount_tag}[,security_model=@var{security_model}][,writeout=@var{writeout}][,readonly][,socket=@var{socket}|sock_fd=@var{sock_fd}][,fmode=@var{fmode}][,dmode=@var{dmode}]
+@item -virtfs @var{fsdriver},path=@var{path},mount_tag=@var{mount_tag},security_model=@var{security_model}[,id=@var{id}][,writeout=@var{writeout}][,readonly][,socket=@var{socket}|sock_fd=@var{sock_fd}][,fmode=@var{fmode}][,dmode=@var{dmode}]
 @findex -virtfs
 
 The general form of a Virtual File system pass-through options are: