From: Luyao Zhong <luyao.zhong@intel.com>
Date: Mon, 23 Sep 2019 10:06:22 +0000 (+0800)
Subject: clarify the xml example for NVDIMM more clealy
X-Git-Tag: v5.8.0-rc1~5
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=cd62dbc03bf3a5c7ee3d155ceafb39dc16ed1b7b;p=thirdparty%2Flibvirt.git

clarify the xml example for NVDIMM more clealy

The NVDIMM backend file can be a normal file or a real device file,
Current xml example and explainations may mislead users. So add more
info about the NVDIMM related elements and update the xml examples.

Signed-off-by: Luyao Zhong <luyao.zhong@intel.com>
Reviewed-by: Michal Privoznik <mprivozn@redhat.com>
---

diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
index 93991aa3d1..647f96f651 100644
--- a/docs/formatdomain.html.in
+++ b/docs/formatdomain.html.in
@@ -8549,7 +8549,6 @@ qemu-kvm -net nic,model=? /dev/null
   &lt;memory model='nvdimm'&gt;
     &lt;source&gt;
       &lt;path&gt;/tmp/nvdimm&lt;/path&gt;
-      &lt;alignsize unit='KiB'&gt;2048&lt;/alignsize&gt;
     &lt;/source&gt;
     &lt;target&gt;
       &lt;size unit='KiB'&gt;524288&lt;/size&gt;
@@ -8560,9 +8559,10 @@ qemu-kvm -net nic,model=? /dev/null
       &lt;readonly/&gt;
     &lt;/target&gt;
   &lt;/memory&gt;
-  &lt;memory model='nvdimm'&gt;
+  &lt;memory model='nvdimm' access='shared'&gt;
     &lt;source&gt;
       &lt;path&gt;/dev/dax0.0&lt;/path&gt;
+      &lt;alignsize unit='KiB'&gt;2048&lt;/alignsize&gt;
       &lt;pmem/&gt;
     &lt;/source&gt;
     &lt;target&gt;
@@ -8596,6 +8596,8 @@ qemu-kvm -net nic,model=? /dev/null
           module basis. Values are the same as
           <a href="#elementsMemoryBacking">Memory Backing</a>:
           <code>shared</code> and <code>private</code>.
+          For <code>nvdimm</code> model, if using real NVDIMM DAX device as
+          backend, <code>shared</code> is required.
         </p>
       </dd>
 
@@ -8659,7 +8661,8 @@ qemu-kvm -net nic,model=? /dev/null
               alignment used to mmap the address range for the backend
               <code>path</code>. If not supplied the host page size is used.
               For example, to mmap a real NVDIMM device a 2M-aligned page may
-              be required.
+              be required, and host page size is 4KB, then we need to set this
+              element to 2MB.
               <span class="since">Since 5.0.0</span>
             </p>
           </dd>