[libvirt PATCH 1/2] docs: virtiofs: move legacy docs to the bottom

[Richard W.M. Jones]

On Thu, Sep 09, 2021 at 03:58:28PM +0100, Stefan Hajnoczi wrote:
> A number of legacy issues make the virtiofs kbase article hard to
> understand. Most users don't need to configure NUMA or a memory backend
> other than memfd. Move that information to the bottom of the article so
> the recommended syntax is most prominent.
> 
> Suggested-by: Richard W.M. Jones <rjones at redhat.com>
> Signed-off-by: Stefan Hajnoczi <stefanha at redhat.com>

This is much better.  There are a couple of minor points below but in
general:

Reviewed-by: Richard W.M. Jones <rjones at redhat.com>

> +Optional parameters
> +===================
> +
> +More optional elements can be specified
> +
> +::
> +
> +  <driver type='virtiofs' queue='1024'/>
> +  <binary path='/usr/libexec/virtiofsd' xattr='on'>
> +    <cache mode='always'/>
> +    <lock posix='on' flock='on'/>
> +  </binary>

I always think with XML it's better to be completely clear about the
context around the element so that users know where to put these extra
elements.  For this reason I'd probably write this:

+  <filesystem type='mount'>
+    <driver type='virtiofs' queue='1024'/>
+    ...
+    <binary path='/usr/libexec/virtiofsd' xattr='on'>
+      <cache mode='always'/>
+      <lock posix='on' flock='on'/>
+    </binary>
+  </filesystem>

> +Externally-launched virtiofsd
> +=============================
> +
> +Libvirtd can also connect the ``vhost-user-fs`` device to a ``virtiofsd``
> +daemon launched outside of libvirtd. In that case socket permissions,
> +the mount tag and all the virtiofsd options are out of libvirtd's
> +control and need to be set by the application running virtiofsd.
> +
> +::
> +
> +  <filesystem type='mount'/>

Is there an extra '/' above ^^ ?

I see the same mistake is present in the current page.

Rich.

-- 
Richard Jones, Virtualization Group, Red Hat http://people.redhat.com/~rjones
Read my programming and virtualization blog: http://rwmj.wordpress.com
virt-p2v converts physical machines to virtual machines.  Boot with a
live CD or over the network (PXE) and turn machines into KVM guests.
http://libguestfs.org/virt-v2v