]> git.ipfire.org Git - thirdparty/libvirt.git/commitdiff
docs: document new socket attribute for virtiofs
authorJán Tomko <jtomko@redhat.com>
Thu, 22 Apr 2021 11:36:35 +0000 (13:36 +0200)
committerJán Tomko <jtomko@redhat.com>
Tue, 27 Apr 2021 17:08:09 +0000 (19:08 +0200)
Describe the attribute and add an example.

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

index 1b9b2216111c16a8173660b76ee13b0401e25da6..282176c4f44f3c8513ec7c5bdadd47782298d6c2 100644 (file)
@@ -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``