[libvirt] [PATCH 2/8] cputune: Add document for cputune xml

[Osier Yang]

* docs/formatdomain.html.in
---
 docs/formatdomain.html.in |   21 +++++++++++++++++++++
 1 files changed, 21 insertions(+), 0 deletions(-)

diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
index 64b0b74..53055d7 100644
--- a/docs/formatdomain.html.in
+++ b/docs/formatdomain.html.in
@@ -288,6 +288,13 @@
     <min_guarantee>65536</min_guarantee>
   </memtune>
   <vcpu cpuset="1-4,^3,6" current="1">2</vcpu>
+  <cputune>
+    <vcpupin vcpu="0" cpuset="1-4,^2">
+    <vcpupin vcpu="1" cpuset="0,1">
+    <vcpupin vcpu="2" cpuset="2,3">
+    <vcpupin vcpu="3" cpuset="0,4">
+    <cpushares>2048</cpushares>
+  </cputune>
   ...</pre>

     <dl>
@@ -346,6 +353,20 @@
         be used to specify whether fewer than the maximum number of
         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>
+      <dt><code>vcpupin</code></dt>
+      <dd> The optional <code>vcpupin</code> 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</vcpu> 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>
+      <dt><code>cpushares</code></dt>
+      <dd> The optional <code>cpushares</code> specifies the proportional
+        weighted share for the domain. If this is ommited, it defaults
+        to the OS provided defaults.</dd>
     </dl>

     <h3><a name="elementsCPU">CPU model and topology</a></h3>
--
1.7.4