From fbdea7cb922635e185b62cefa88aa298786e1d0a Mon Sep 17 00:00:00 2001
From: Wen Congyang <wency@cn.fujitsu.com>
Date: Thu, 21 Jul 2011 16:36:39 +0800
Subject: [PATCH] doc: Add documentation for new cputune elements period and
 quota

We have added element period and quota. Document them in formatdomain.html.in.
---
 docs/formatdomain.html.in | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
index a54ee6a8ef..8c5c4c9965 100644
--- a/docs/formatdomain.html.in
+++ b/docs/formatdomain.html.in
@@ -307,6 +307,8 @@
     &lt;vcpupin vcpu="2" cpuset="2,3"/&gt;
     &lt;vcpupin vcpu="3" cpuset="0,4"/&gt;
     &lt;shares&gt;2048&lt;/shares&gt;
+    &lt;period&gt;1000000&lt;/period&gt;
+    &lt;quota&gt;-1&lt;/quota&gt;
   &lt;/cputune&gt;
   &lt;numatune&gt;
     &lt;memory mode="strict" nodeset="1-4,^3"/&gt;
@@ -400,6 +402,26 @@
         2048 will get twice as much CPU time as a VM configured with value 1024.
         <span class="since">Since 0.9.0</span>
       </dd>
+      <dt><code>period</code></dt>
+      <dd>
+        The optional <code>period</code> element specifies the enforcement
+        interval(unit: microseconds). Within <code>period</code>, each vcpu of
+        the domain will not be allowed to consume more than <code>quota</code>
+        worth of runtime. The value should be in range [1000, 1000000]. A period
+        with value 0 means no value. (NB: Only qemu driver support)
+        <span class="since">Since 0.9.4</span>
+      </dd>
+      <dt><code>quota</code></dt>
+      <dd>
+        The optional <code>quota</code> element specifies the maximum allowed
+        bandwidth(unit: microseconds). A domain with <code>quota</code> as any
+        negative value indicates that the domain has infinite bandwidth, which
+        means that it is not bandwidth controlled. The value should be in range
+        [1000, 18446744073709551] or less than 0. A quota with value 0 means no
+        value. You can use this feature to ensure that all vcpus run at the same
+        speed. (NB: Only qemu driver support)
+        <span class="since">Since 0.9.4</span>
+      </dd>
       <dt><code>numatune</code></dt>
       <dd>
         The optional <code>numatune</code> element provides details of
-- 
GitLab