qsd: Document fuse's allow-other option
PATCH v2 1/1 qsd: Document fuse's allow-other option
We did not add documentation to the storage daemon's man page for fuse's allow-other option when it was introduced, so do that now.
---
v2:
- Replaced instances of "QSD" by more generic descriptions, as suggested by Kevin.
v1 patch:
https://lists.nongnu.org/archive/html/qemu-block/2022-01/msg00567.html
--- docs/tools/qemu-storage-daemon.rst | 9 +++++++-- storage-daemon/qemu-storage-daemon.c | 2 +- 2 files changed, 8 insertions(+), 3 deletions(-)
docs/tools/qemu-storage-daemon.rst +7 -2
@@ -76,7 +76,7 @@ Standard options: .. option:: --export [type=]nbd,id=<id>,node-name=<node-name>[,name=<export-name>][,writable=on|off][,bitmap=<name>] --export [type=]vhost-user-blk,id=<id>,node-name=<node-name>,addr.type=unix,addr.path=<socket-path>[,writable=on|off][,logical-block-size=<block-size>][,num-queues=<num-queues>] --export [type=]vhost-user-blk,id=<id>,node-name=<node-name>,addr.type=fd,addr.str=<fd>[,writable=on|off][,logical-block-size=<block-size>][,num-queues=<num-queues>] - --export [type=]fuse,id=<id>,node-name=<node-name>,mountpoint=<file>[,growable=on|off][,writable=on|off] + --export [type=]fuse,id=<id>,node-name=<node-name>,mountpoint=<file>[,growable=on|off][,writable=on|off][,allow-other=on|off|auto] is a block export definition. ``node-name`` is the block node that should be exported. ``writable`` determines whether or not the export allows write
@@ -103,7 +103,12 @@ Standard options: mounted). Consequently, applications that have opened the given file before the export became active will continue to see its original content. If ``growable`` is set, writes after the end of the exported file will grow the - block node to fit. + block node to fit. The ``allow-other`` option controls whether users other + than the user running the process will be allowed to access the export. Note + that enabling this option as a non-root user requires enabling the + user_allow_other option in the global fuse.conf configuration file. Setting + ``allow-other`` to auto (the default) will try enabling this option, and on + error fall back to disabling it. .. option:: --monitor MONITORDEF
storage-daemon/qemu-storage-daemon.c +1 -1
@@ -100,7 +100,7 @@ static void help(void) "\n"#ifdef CONFIG_FUSE " --export [type=]fuse,id=<id>,node-name=<node-name>,mountpoint=<file>\n" -" [,growable=on|off][,writable=on|off]\n" +" [,growable=on|off][,writable=on|off][,allow-other=on|off|auto]\n" " export the specified block node over FUSE\n" "\n"#endif /* CONFIG_FUSE */
Signature · 1 line
2.34.1
Quoted 10 lines · Hanna Reitz
We did not add documentation to the storage daemon's man page for fuse's allow-other option when it was introduced, so do that now.
Fixes 8fc54f9428b9763f800 ("export/fuse: Add allow-other option")Signed-off-by Hanna Reitz <[email protected]>---
v2:
- Replaced instances of "QSD" by more generic descriptions, as suggested by Kevin.
Signature · 3 lines
Eric Blake, Principal Software Engineer Red Hat, Inc. +1-919-301-3266 Virtualization: qemu.org | libvirt.org
Kevin Wolf
AppliedAm 31.01.2022 um 11:31 hat Hanna Reitz geschrieben:
Quoted 5 lines
We did not add documentation to the storage daemon's man page for fuse's allow-other option when it was introduced, so do that now.
Fixes 8fc54f9428b9763f800 ("export/fuse: Add allow-other option")Signed-off-by Hanna Reitz <[email protected]>
Thanks, applied to the block branch.
Kevin