From: Osier Yang <jyang@redhat.com>
Date: Thu, 12 May 2011 10:48:23 +0000 (+0800)
Subject: docs: Fix documentation for cputune parameters
X-Git-Url: http://xenbits.xensource.com/gitweb?a=commitdiff_plain;h=81cfe719981d62727b2e87b5361b6805e6f99218;p=libvirt.git

docs: Fix documentation for cputune parameters

This re-adds the example section originally written by Osier Yang,
and indicates the version in which the cputune parameters became
available in libvirt.

Signed-off-by: Igor Serebryany <igor47@moomers.org>
---

diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
index dcfcd9424e..989dcf6317 100644
--- a/docs/formatdomain.html.in
+++ b/docs/formatdomain.html.in
@@ -288,6 +288,13 @@
     &lt;min_guarantee&gt;65536&lt;/min_guarantee&gt;
   &lt;/memtune&gt;
   &lt;vcpu cpuset="1-4,^3,6" current="1"&gt;2&lt;/vcpu&gt;
+  &lt;cputune&gt;
+    &lt;vcpupin vcpu="0" cpuset="1-4,^2"&gt;
+    &lt;vcpupin vcpu="1" cpuset="0,1"&gt;
+    &lt;vcpupin vcpu="2" cpuset="2,3"&gt;
+    &lt;vcpupin vcpu="3" cpuset="0,4"&gt;
+    &lt;cpushares&gt;2048&lt;/cpushares&gt;
+  &lt;/cputune&gt;
   ...</pre>
 
     <dl>
@@ -351,21 +358,30 @@
         virtual CPUs should be enabled.
       </dd>
       <dt><code>cputune</code></dt>
-      <dd> The optional <code>cputune</code> element provides details
-        regarding the cpu tunable parameters for the domain.</dd>
+      <dd>
+         The optional <code>cputune</code> element provides details
+         regarding the cpu tunable parameters for the domain.
+         <span class="since">Since 0.9.0</span>
+      </dd>
       <dt><code>vcpupin</code></dt>
-      <dd> The optional <code>vcpupin</code> element specifies which of host
+      <dd>
+        The optional <code>vcpupin</code> element specifies which of host
         physical CPUS the domain VCPU will be pinned to. If this is ommited,
         each VCPU pinned to all the physical CPUS by default. It contains two
         required attributes, the attribute <code>vcpu</code> specifies vcpu id,
         and the attribute <code>cpuset</code> is same as attribute <code>cpuset</code>
-        of element <code>vcpu</code>. NB, Only qemu driver supports</dd>
+        of element <code>vcpu</code>. (NB: Only qemu driver support)
+        <span class="since">Since 0.9.0</span>
+       </dd>
       <dt><code>shares</code></dt>
-      <dd> The optional <code>shares</code> element specifies the proportional
+      <dd>
+        The optional <code>shares</code> element specifies the proportional
         weighted share for the domain. If this is ommited, it defaults to
         the OS provided defaults. NB, There is no unit for the value, it's a relative
         measure based on the setting of other VM, e.g. A VM configured with value
-        2048 will get twice as much CPU time as a VM configured with value 1024.</dd>
+        2048 will get twice as much CPU time as a VM configured with value 1024.
+        <span class="since">Since 0.9.0</span>
+      </dd>
     </dl>
 
     <h3><a name="elementsCPU">CPU model and topology</a></h3>