[PATCH] docs: document <driver name='vhost'/> for interfaces

[Eric Blake <eblake@xxxxxxxxxx>]

* docs/formatdomain.html.in: Document virtio backend selection.
---

How about I help out? :)

 docs/formatdomain.html.in |   14 +++++++++++++-
 1 files changed, 13 insertions(+), 1 deletions(-)

diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
index 0c7c965..8307a0d 100644
--- a/docs/formatdomain.html.in
+++ b/docs/formatdomain.html.in
@@ -1388,7 +1388,7 @@ qemu-kvm -net nic,model=? /dev/null
       <source network='default'/>
       <target dev='vnet1'/>
       <model type='virtio'/>
-      <b>&lt;driver txmode='iothread'/&gt;</b>
+      <b>&lt;driver name='vhost' txmode='iothread'/&gt;</b>
     &lt;/interface&gt;
   &lt;/devices&gt;
   ...</pre>
@@ -1401,6 +1401,18 @@ qemu-kvm -net nic,model=? /dev/null
     </p>

     <dl>
+      <dt><code>name</code></dt>
+      <dd>
+        The optional <code>name</code> attribute forces which type of
+        backend driver to use. The value can be either 'qemu' (a
+        user-space backend) or 'vhost' (a kernel backend, which
+        requires the vhost module to be provided by the kernel); an
+        attempt to require the vhost driver without kernel support
+        will be rejected.  If this attribute is not present, then the
+        domain defaults to 'vhost' if present, but silently falls back
+        to 'qemu' without error.
+        <span class="since">Since 0.8.8 (QEMU and KVM only)</span>
+      </dd>
       <dt><code>txmode</code></dt>
       <dd>
         The <code>txmode</code> attribute specifies how to handle
-- 
1.7.4

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