From: Stefan Hajnoczi <stefanha@gmail.com>
Date: Mon, 7 Jun 2021 13:50:24 +0000 (+0100)
Subject: docs: virtiofs: describe memfd memory backend
X-Git-Tag: v7.5.0-rc1~190
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=e30584ff06d9c796b59cdea881f7e3a20522598c;p=thirdparty%2Flibvirt.git

docs: virtiofs: describe memfd memory backend

Nowadays memfd is the most convenient memory backend for vhost-user
devices. Compared to file-backend memory and hugepages, there is no need
to worry about configuring the location of the shm directory or
allocating hugepages.

Cc: Michal Prívozník <mprivozn@redhat.com>
Cc: Ján Tomko <jtomko@redhat.com>
Signed-off-by: Stefan Hajnoczi <stefanha@gmail.com>
Reviewed-by: Michal Privoznik <mprivozn@redhat.com>
---

diff --git a/docs/kbase/virtiofs.rst b/docs/kbase/virtiofs.rst
index 740b08d50d..8cf7567bf8 100644
--- a/docs/kbase/virtiofs.rst
+++ b/docs/kbase/virtiofs.rst
@@ -29,7 +29,11 @@ NUMA. As of QEMU 5.0.0 and libvirt 6.9.0, it is possible to
 specify the memory backend without NUMA (using the so called
 memobject interface).
 
-Either of the following:
+One of the following:
+
+* Use memfd memory
+
+  No host setup is required when using the Linux memfd memory backend.
 
 * Use file-backed memory
 
@@ -75,7 +79,20 @@ Guest setup
 
 #. Specify the memory backend
 
-   Either of the following:
+   One of the following:
+
+   * memfd memory
+
+     ::
+
+        <domain>
+          ...
+          <memoryBacking>
+            <source type='memfd'/>
+            <access mode='shared'/>
+          </memoryBacking>
+          ...
+        </domain>
 
    * File-backed memory