Skip to contentSkip to conversation

virtfs: Add missing "id" parameter in documentation

PATCH In review Thomas Huth 2 participants 4 messages May 5, 2019 – May 6, 2019

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 virtfs: Add missing "id" parameter in documentation

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

---
 qemu-options.hx | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
qemu-options.hx +1 -1
index 51802cbb26..9571ddd141 100644
@@ -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:
Signature · 1 line
2.21.0
#1 lore raw

Hi Thomas,

Thanks for the janitoring :)

Quoted 3 lines · On Sun, 5 May 2019 16:45:27 +0200 Thomas Huth <[email protected]> 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

Quoted 19 lines
---
 qemu-options.hx | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
qemu-options.hx +1 -1
index 51802cbb26..9571ddd141 100644
@@ -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:
#2 lore raw
Quoted 7 lines · Greg Kurz

Hi Thomas,

Thanks for the janitoring :)

On Sun, 5 May 2019 16:45:27 +0200
Thomas Huth <[email protected]> wrote:

Quoted 6 lines
Quoted 3 lines

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

Quoted 6 lines

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

#3 lore raw
Quoted 8 lines · On Mon, 6 May 2019 05:49:40 +0200 Thomas Huth <[email protected]> wrote:
Quoted 7 lines · Greg Kurz

Hi Thomas,

Thanks for the janitoring :)

On Sun, 5 May 2019 16:45:27 +0200
Thomas Huth <[email protected]> wrote:

Quoted 9 lines
Quoted 6 lines
Quoted 3 lines

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

Quoted 11 lines
Quoted 6 lines

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.

Quoted 1 line

Thomas

Cheers,

--
Greg