External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2024-07-30 13:37:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

clarify the xml example for NVDIMM more clealy

Browse Source 
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>
This commit is contained in:
Luyao Zhong 2019-09-23 18:06:22 +08:00 committed by Michal Privoznik
parent d660dd95ea
commit cd62dbc03b
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/formatdomain.html.in
View File

@ -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>