[libvirt] [PATCH 3/3] Add support for preallocated fd memory - doc

[Martin Kletzander]

On Tue, Nov 01, 2016 at 12:11:16PM +0000, Jaroslav Safka wrote:
>Add html documentation for memoryBacking element.

We usually merge documentation with the conf changes.

>---
> docs/formatdomain.html.in | 10 ++++++++++
> 1 file changed, 10 insertions(+)
>
>diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
>index c70377b..ed15eb5 100644
>--- a/docs/formatdomain.html.in
>+++ b/docs/formatdomain.html.in
>@@ -903,6 +903,9 @@
>     </hugepages>
>     <nosharepages/>
>     <locked/>
>+    <source type='file|anonymous'/>
>+    <access mode='shared|private'>
>+    <allocation mode='immediate|ondemand'/>
>   </memoryBacking>
>   ...
> </domain>
>@@ -942,6 +945,13 @@
>         most of the host's memory). Doing so may be dangerous to both the
>         domain and the host itself since the host's kernel may run out of
>         memory. <span class="since">Since 1.0.6</span></dd>
>+      <dt><code>source</code></dt>
>+        <dd>If the option "file" is selected, then token "mem-path=/var/lib/libvirt/qemu" will be added to object argument.</dd>

You should say it is the <code>type</code> attribute.  Also  talking
about tokens being added to object argument makes no sense for the
reader.  And I'm not talking about hypervisors other than QEMU where it
doesn't make sense even to developers.

>+      <dt><code>access</code></dt>
>+        <dd>Specify if memory is shared or private. This can be overridden by numa cell element memAccess.

overridden *per node*.  We enclose element and attribute names inside
<code/> so that others can see that you are referring to something.

>+        If share is selected then token "share=yes" will be added to object memory-backend-file.</dd>

Again, this makes no sense in high-lieve documentation.

>+      <dt><code>allocation</code></dt>
>+        <dd>Immediate - preallocate the memory immediately</dd>

^^ no comment.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 833 bytes
Desc: Digital signature
URL: <http://listman.redhat.com/archives/libvir-list/attachments/20161125/de1eb613/attachment-0001.sig>