]> xenbits.xensource.com Git - libvirt.git/commitdiff
docs: domain: document blkiotune {read, write}_{bytes, iops}_sec
authorCole Robinson <crobinso@redhat.com>
Wed, 13 Apr 2016 20:37:17 +0000 (16:37 -0400)
committerCole Robinson <crobinso@redhat.com>
Thu, 14 Apr 2016 16:55:26 +0000 (12:55 -0400)
Added with commit 3b431929 in v1.2.2 but never documented

https://bugzilla.redhat.com/show_bug.cgi?id=1313613

docs/formatdomain.html.in

index c2955eb3670a540c03d07a8186149dc2484b773f..fef2f25465674ba5e01f041100ac34bf8cb56e7b 100644 (file)
     &lt;device&gt;
       &lt;path&gt;/dev/sdb&lt;/path&gt;
       &lt;weight&gt;500&lt;/weight&gt;
+      &lt;read_bytes_sec&gt;10000&lt;/read_bytes_sec&gt;
+      &lt;write_bytes_sec&gt;10000&lt;/write_bytes_sec&gt;
+      &lt;read_iops_sec&gt;20000&lt;/read_iops_sec&gt;
+      &lt;write_iops_sec&gt;20000&lt;/write_iops_sec&gt;
     &lt;/device&gt;
   &lt;/blkiotune&gt;
   ...
         absolute path of the device, and <code>weight</code> giving
         the relative weight of that device, in the range [100,
         1000]. After kernel 2.6.39, the value could be in the
-        range [10, 1000].<span class="since">Since 0.9.8</span></dd>
-    </dl>
+        range [10, 1000]. <span class="since">Since 0.9.8</span><br/>
+        Additionally, the following optional sub-elements can be used:
+        <dl>
+          <dt><code>read_bytes_sec</code></dt>
+          <dd>Read throughput limit in bytes per second.
+            <span class="since">Since 1.2.2</span></dd>
+          <dt><code>write_bytes_sec</code></dt>
+          <dd>Write throughput limit in bytes per second.
+            <span class="since">Since 1.2.2</span></dd>
+          <dt><code>read_iops_sec</code></dt>
+          <dd>Read I/O operations per second limit.
+            <span class="since">Since 1.2.2</span></dd>
+          <dt><code>write_iops_sec</code></dt>
+          <dd>Write I/O operations per second limit.
+            <span class="since">Since 1.2.2</span></dd>
+      </dl></dd></dl>
 
 
     <h3><a name="resPartition">Resource partitioning</a></h3>