Re: [Qemu-devel] [PATCH] virtiofsd: add man page

[Stefan Hajnoczi]

On Tue, Sep 03, 2019 at 04:35:39PM +0100, Dr. David Alan Gilbert wrote:
> * Stefan Hajnoczi (address@hidden) wrote:
> > Signed-off-by: Stefan Hajnoczi <address@hidden>
> > ---
> >  Makefile                         |  7 +++
> >  contrib/virtiofsd/virtiofsd.texi | 85 ++++++++++++++++++++++++++++++++
> >  2 files changed, 92 insertions(+)
> >  create mode 100644 contrib/virtiofsd/virtiofsd.texi
> > 
> > diff --git a/Makefile b/Makefile
> > index a3dfdd6fa8..cc18025753 100644
> > --- a/Makefile
> > +++ b/Makefile
> > @@ -334,6 +334,9 @@ DOCS+=docs/qemu-cpu-models.7
> >  ifdef CONFIG_VIRTFS
> >  DOCS+=fsdev/virtfs-proxy-helper.1
> >  endif
> > +ifdef CONFIG_LINUX
> 
> Is there a reason that's CONFIG_LINUX not CONFIG_VHOST_USER_FS ?
> (Although I guess it's guest vs daemon so the two are independent?)

Yes, this is virtiofsd, not vhost-user-fs-pci.  We don't have a
CONFIG_VIRTIOFSD.

> > +DOCS+=contrib/virtiofsd/virtiofsd.1
> > +endif
> >  ifdef CONFIG_TRACE_SYSTEMTAP
> >  DOCS+=scripts/qemu-trace-stap.1
> >  endif
> > @@ -834,6 +837,9 @@ ifdef CONFIG_VIRTFS
> >     $(INSTALL_DIR) "$(DESTDIR)$(mandir)/man1"
> >     $(INSTALL_DATA) fsdev/virtfs-proxy-helper.1 "$(DESTDIR)$(mandir)/man1"
> >  endif
> > +ifdef CONFIG_LINUX
> > +   $(INSTALL_DATA) contrib/virtiofsd.1 "$(DESTDIR)$(mandir)/man1"
> 
> I had to fix that to contrib/virtiofsd/virtiofsd.1 to get make install
> happy.

Thanks for spotting it!

> > +@c man begin DESCRIPTION
> > +
> > +Share a host directory tree with a guest through a virtio-fs device.  This
> > +program is a vhost-user backend that implements the virtio-fs device.  Each
> > +virtio-fs device instance requires its own virtiofsd process.
> > +
> > +This program is designed to work with QEMU's @code{--device 
> > vhost-user-fs-pci}
> 
> Should we include the -pci there?
> 
> (Merged with the path fix above)

We could also be more general and say "vhost-user virtio-fs device" to
avoid the issue.

Stefan

signature.asc
Description: PGP signature