From: Ján Tomko <jtomko@redhat.com>
Date: Thu, 22 Apr 2021 11:36:35 +0000 (+0200)
Subject: docs: document new socket attribute for virtiofs
X-Git-Tag: v7.3.0-rc2~5
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=4920678f40f40675835effa8dee6c5ed09204c29;p=thirdparty%2Flibvirt.git

docs: document new socket attribute for virtiofs

Describe the attribute and add an example.

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

diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst
index 1b9b221611..282176c4f4 100644
--- a/docs/formatdomain.rst
+++ b/docs/formatdomain.rst
@@ -3242,6 +3242,10 @@ A directory on the host that can be accessed directly from the guest.
          <source dir='/path'/>
          <target dir='mount_tag'/>
      </filesystem>
+     <filesystem type='mount'>
+         <driver type='virtiofs' queue='1024'/>
+         <source socket='/tmp/sock'/>
+     </filesystem>
      ...
    </devices>
    ...
@@ -3369,7 +3373,11 @@ A directory on the host that can be accessed directly from the guest.
 ``source``
    The resource on the host that is being accessed in the guest. The ``name``
    attribute must be used with ``type='template'``, and the ``dir`` attribute
-   must be used with ``type='mount'``. The ``usage`` attribute is used with
+   must be used with ``type='mount'``. For ``virtiofs``, the ``socket`` attribute
+   can be used to connect to a virtiofsd daemon launched outside of libvirt.
+   In that case, the ``target`` element does not apply and neither do most
+   virtiofs-related options, since they are controlled by virtiofsd, not libvirtd.
+   The ``usage`` attribute is used with
    ``type='ram'`` to set the memory limit in KiB, unless units are specified by
    the ``units`` attribute.
 ``target``