diff mbox series

[2/2] virtiofsd: Add help for -o xattr-mapping

Message ID 20210414201207.3612432-3-jose.carlos.venegas.munoz@intel.com (mailing list archive)
State New, archived
Headers show
Series virtiofsd: Enable xattr if xattrmap is used | expand

Commit Message

Venegas Munoz, Jose Carlos April 14, 2021, 8:12 p.m. UTC
The option is not documented in help.

Add small help about the option.

Signed-off-by: Carlos Venegas <jose.carlos.venegas.munoz@intel.com>
---
 tools/virtiofsd/helper.c | 3 +++
 1 file changed, 3 insertions(+)

Comments

Connor Kuehl April 14, 2021, 9:44 p.m. UTC | #1
On Wed Apr 14, 2021 at 3:12 PM CDT, Carlos Venegas wrote:
> The option is not documented in help.
>
> Add small help about the option.
>
> Signed-off-by: Carlos Venegas <jose.carlos.venegas.munoz@intel.com>
> ---
> tools/virtiofsd/helper.c | 3 +++
> 1 file changed, 3 insertions(+)
>
> diff --git a/tools/virtiofsd/helper.c b/tools/virtiofsd/helper.c
> index 28243b51b2..5e98ed702b 100644
> --- a/tools/virtiofsd/helper.c
> +++ b/tools/virtiofsd/helper.c
> @@ -172,6 +172,9 @@ void fuse_cmdline_help(void)
> " default: no_writeback\n"
> " -o xattr|no_xattr enable/disable xattr\n"
> " default: no_xattr\n"
> + " -o xattrmap=<mapping> Enable xattr mapping (enables xattr)\n"
> + " <mapping> is a string consists of a series of rules\n"
> + " e.g. -o xattrmap=:map::user.virtiofs.:\n"

This is a helpful note, but it doesn't tell the whole story. I think
it'd be helpful to add one last note to this option which is to
recommend reading the virtiofsd(1) man-page for more information on
xattrmap rules.

Connor
Vivek Goyal April 19, 2021, 7:07 p.m. UTC | #2
On Wed, Apr 14, 2021 at 04:44:26PM -0500, Connor Kuehl wrote:
> On Wed Apr 14, 2021 at 3:12 PM CDT, Carlos Venegas wrote:
> > The option is not documented in help.
> >
> > Add small help about the option.
> >
> > Signed-off-by: Carlos Venegas <jose.carlos.venegas.munoz@intel.com>
> > ---
> > tools/virtiofsd/helper.c | 3 +++
> > 1 file changed, 3 insertions(+)
> >
> > diff --git a/tools/virtiofsd/helper.c b/tools/virtiofsd/helper.c
> > index 28243b51b2..5e98ed702b 100644
> > --- a/tools/virtiofsd/helper.c
> > +++ b/tools/virtiofsd/helper.c
> > @@ -172,6 +172,9 @@ void fuse_cmdline_help(void)
> > " default: no_writeback\n"
> > " -o xattr|no_xattr enable/disable xattr\n"
> > " default: no_xattr\n"
> > + " -o xattrmap=<mapping> Enable xattr mapping (enables xattr)\n"
> > + " <mapping> is a string consists of a series of rules\n"
> > + " e.g. -o xattrmap=:map::user.virtiofs.:\n"
> 
> This is a helpful note, but it doesn't tell the whole story. I think
> it'd be helpful to add one last note to this option which is to
> recommend reading the virtiofsd(1) man-page for more information on
> xattrmap rules.

Is there a virtiofsd man page as well? All I see is
docs/tools/virtiofsd.rst.

Vivek
Connor Kuehl April 19, 2021, 7:21 p.m. UTC | #3
On 4/19/21 2:07 PM, Vivek Goyal wrote:
>> This is a helpful note, but it doesn't tell the whole story. I think
>> it'd be helpful to add one last note to this option which is to
>> recommend reading the virtiofsd(1) man-page for more information on
>> xattrmap rules.
> 
> Is there a virtiofsd man page as well? All I see is
> docs/tools/virtiofsd.rst.

Yes, it's generated from that file. Should be located in
qemu/build/docs/virtiofsd.1 after building QEMU.

Connor
Vivek Goyal April 19, 2021, 7:59 p.m. UTC | #4
On Mon, Apr 19, 2021 at 02:21:11PM -0500, Connor Kuehl wrote:
> On 4/19/21 2:07 PM, Vivek Goyal wrote:
> >> This is a helpful note, but it doesn't tell the whole story. I think
> >> it'd be helpful to add one last note to this option which is to
> >> recommend reading the virtiofsd(1) man-page for more information on
> >> xattrmap rules.
> > 
> > Is there a virtiofsd man page as well? All I see is
> > docs/tools/virtiofsd.rst.
> 
> Yes, it's generated from that file. Should be located in
> qemu/build/docs/virtiofsd.1 after building QEMU.

Ok thanks. I guess that gets build only if I pass option --enable-docs. 

Thanks
Vivek
diff mbox series

Patch

diff --git a/tools/virtiofsd/helper.c b/tools/virtiofsd/helper.c
index 28243b51b2..5e98ed702b 100644
--- a/tools/virtiofsd/helper.c
+++ b/tools/virtiofsd/helper.c
@@ -172,6 +172,9 @@  void fuse_cmdline_help(void)
            "                               default: no_writeback\n"
            "    -o xattr|no_xattr          enable/disable xattr\n"
            "                               default: no_xattr\n"
+           "    -o xattrmap=<mapping>      Enable xattr mapping (enables xattr)\n"
+           "                               <mapping> is a string consists of a series of rules\n"
+           "                               e.g. -o xattrmap=:map::user.virtiofs.:\n"
            "    -o modcaps=CAPLIST         Modify the list of capabilities\n"
            "                               e.g. -o modcaps=+sys_admin:-chown\n"
            "    --rlimit-nofile=<num>      set maximum number of file descriptors\n"