From: Marc-André Lureau <marcandre.lureau@redhat.com>
Date: Wed, 7 Oct 2015 14:31:47 +0000 (+0200)
Subject: doc: document ivshmem & hugepages
X-Git-Url: http://git.maquefel.me/?a=commitdiff_plain;h=7d4f4bdaf785dfe9fc41b06f85cc9aaf1b1474ee;p=qemu.git

doc: document ivshmem & hugepages

Document and give some examples of hugepages support with ivshmem device
and server.

Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
---

diff --git a/qemu-doc.texi b/qemu-doc.texi
index afa226303b..3126abdcd3 100644
--- a/qemu-doc.texi
+++ b/qemu-doc.texi
@@ -1293,6 +1293,19 @@ copy the shared memory on migration to the destination host.  With
 With the @option{peer} case, the device should be detached and then reattached
 after migration using the PCI hotplug support.
 
+@subsubsection ivshmem and hugepages
+
+Instead of specifying the <shm size> using POSIX shm, you may specify
+a memory backend that has hugepage support:
+
+@example
+qemu-system-i386 -object memory-backend-file,size=1G,mem-path=/mnt/hugepages,id=mb1
+                 -device ivshmem,memdev=mb1
+@end example
+
+ivshmem-server also supports hugepages mount points with the
+@option{-m} memory path argument.
+
 @node direct_linux_boot
 @section Direct Linux Boot