From: Ján Tomko <jtomko@redhat.com>
Date: Thu, 22 Apr 2021 11:37:04 +0000 (+0200)
Subject: docs: virtiofs: add section about externally-launched virtiofsd
X-Git-Tag: v7.3.0-rc2~4
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=eacf8978e94f73535676f40c70d4be8058d6b839;p=thirdparty%2Flibvirt.git

docs: virtiofs: add section about externally-launched virtiofsd

Provide an exmple in a place more visible than formatdomain.html.

Signed-off-by: Ján Tomko <jtomko@redhat.com>
Reviewed-by: Jonathon Jongsma <jjongsma@redhat.com>
---

diff --git a/docs/kbase/virtiofs.rst b/docs/kbase/virtiofs.rst
index c0bc07a68d..740b08d50d 100644
--- a/docs/kbase/virtiofs.rst
+++ b/docs/kbase/virtiofs.rst
@@ -149,3 +149,18 @@ More optional elements can be specified
     <cache mode='always'/>
     <lock posix='on' flock='on'/>
   </binary>
+
+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'/>
+    <driver type='virtiofs' queue='1024'/>
+    <source socket='/var/virtiofsd.sock'/>
+  </filesystem>