[PATCH 1/2] docs: formatdomain: add info about global_period and global_quota for cputune

[Katerina Koukiou <kkoukiou@xxxxxxxxxx>]

Patch series
https://www.redhat.com/archives/libvir-list/2016-January/msg00482.html
introduced the parameters but didn't update the docs.

Signed-off-by: Katerina Koukiou <kkoukiou@xxxxxxxxxx>
---
 docs/formatdomain.html.in | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
index a3afe137bf..7fa448acdc 100644
--- a/docs/formatdomain.html.in
+++ b/docs/formatdomain.html.in
@@ -747,6 +747,8 @@
     &lt;shares&gt;2048&lt;/shares&gt;
     &lt;period&gt;1000000&lt;/period&gt;
     &lt;quota&gt;-1&lt;/quota&gt;
+    &lt;global_period&gt;1000000&lt;/global_period&gt;
+    &lt;global_quota&gt;-1&lt;/global_quota&gt;
     &lt;emulator_period&gt;1000000&lt;/emulator_period&gt;
     &lt;emulator_quota&gt;-1&lt;/emulator_quota&gt;
     &lt;iothread_period&gt;1000000&lt;/iothread_period&gt;
@@ -837,6 +839,25 @@
         <span class="since">Only QEMU driver support since 0.9.4, LXC since
         0.9.10</span>
       </dd>
+      <dt><code>global_period</code></dt>
+      <dd>
+        The optional <code>global_period</code> element specifies the
+        enforcement period for a quota (unit: microseconds) for whole domain,
+        when using posix scheduler. The value should be in range
+        [1000, 1000000]. A global_period with value 0 means no value.
+        <span class="since">Only QEMU driver support since 1.3.3</span>
+      </dd>
+      <dt><code>global_quota</code></dt>
+      <dd>
+        The optional <code>global_quota</code> element specifies the maximum
+        allowed bandwidth (unit: microseconds) to be used within a period for
+        whole domain. A domain with <code>global_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 global_quota with value 0
+        means no value.
+        <span class="since">Only QEMU driver support since 1.3.3</span>
+      </dd>
 
       <dt><code>emulator_period</code></dt>
       <dd>
-- 
2.17.1

--
libvir-list mailing list
libvir-list@xxxxxxxxxx
https://www.redhat.com/mailman/listinfo/libvir-list