[libvirt] [PATCH 6/8] Docs: Add description and validation for blkdeviotune

[Lei Li]

Signed-off-by: Lei Li <lilei at linux.vnet.ibm.com>
Signed-off-by: Zhi Yong Wu <wuzhy at linux.vnet.ibm.com>
---
 docs/formatdomain.html.in     |   31 +++++++++++++++++++++++++++++++
 docs/schemas/domaincommon.rng |   24 ++++++++++++++++++++++++
 2 files changed, 55 insertions(+), 0 deletions(-)

diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
index cbad196..733062d 100644
--- a/docs/formatdomain.html.in
+++ b/docs/formatdomain.html.in
@@ -893,6 +893,14 @@
       <driver name="tap" type="aio" cache="default"/>
       <source file='/var/lib/xen/images/fv0'/ startupPolicy='optional'>
       <target dev='hda' bus='ide'/>
+      <iotune>
+        <total_bytes_sec>n</total_bytes_sec>
+        <read_bytes_sec>n</read_bytes_sec>
+        <write_bytes_sec>n</write_bytes_sec>
+        <total_iops_sec>n</total_iops_sec>
+        <read_bytes_sec>n</read_bytes_sec>
+        <write_bytes_sec>n</write_bytes_sec>
+      </iotune>
       <boot order='2'/>
       <encryption type='...'>
         ...
@@ -1010,6 +1018,29 @@
         <span class="since">Since 0.0.3; <code>bus</code> attribute since 0.4.3;
         "usb" attribute value since after 0.4.4; "sata" attribute value since
         0.9.7</span></dd>
+      <dt><code>iotune</code></dt>
+      <dd>The optional <code>iotune</code> element provides the ability
+        to set or get block I/O throttling for the device. Block I/O
+        throtting be implemented by qemu, is specified per-disk and can
+        vary across multiple disks.</dd>
+      <dt><code>total_bytes_sec</code></dt>
+      <dd>The optinal <code>total_bytes_sec</code> element is the total throughput
+        limit in bytes per second.</dd>
+      <dt><code>read_bytes_sec</code></dt>
+      <dd>The optinal <code>read_bytes_sec</code> element is the read throughput
+        limit in bytes per second.</dd>
+      <dt><code>write_bytes_sec</code</dt>
+      <dd>The optinal <code>write_bytes_sec</code> element is the write throughput
+        limit in bytes per second.</dd>
+      <dt><code>total_iops_sec</code></dt>
+      <dd>The optional <code>total_iops_sec</code> element is the total I/O operations
+        per second.</dd>
+      <dt><code>read_iops_sec</code></dt>
+      <dd>The optional <code>read_iops_sec</code> element is the read I/O operations
+        per second.</dd>
+      <dt><code>write_iops_sec</code></dt>
+      <dd>The optional <code>write_iops_sec</code> element is the write I/O operations
+        per second.</dd>
       <dt><code>driver</code></dt>
       <dd>
         The optional driver element allows specifying further details
diff --git a/docs/schemas/domaincommon.rng b/docs/schemas/domaincommon.rng
index b6f858e..c6873a0 100644
--- a/docs/schemas/domaincommon.rng
+++ b/docs/schemas/domaincommon.rng
@@ -698,6 +698,30 @@
       <optional>
         <ref name="snapshot"/>
       </optional>
+      <optional>
+        <element name="iotune">
+          <choice>
+            <element name="total_bytes_sec">
+              <ref name="unsignedLongLong">
+            </element>
+            <element name="read_bytes_sec">
+              <ref name="unsignedLongLong">
+            </element>
+            <element name="write_bytes_sec">
+              <ref name="unsignedLongLong">
+            </element>
+            <element name="total_iops_sec">
+              <ref name="unsignedLongLong">
+            </element>
+            <element name="read_iops_sec">
+              <ref name="unsignedLongLong">
+            </element>
+            <element name="write_iopw_sec">
+              <ref name="unsignedLongLong">
+            </emement>
+          </choice>
+        </element>
+      </optional>
       <choice>
         <group>
           <attribute name="type">
-- 
1.7.1