From: Eric Blake <eblake@redhat.com>
Date: Tue, 8 Mar 2011 23:35:17 +0000 (-0700)
Subject: docs: document <driver name='vhost'/> for interfaces
X-Git-Url: http://xenbits.xensource.com/gitweb?a=commitdiff_plain;h=94a4b6300c577eb487d4d792ee1f18e2ee5548dd;p=libvirt.git

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

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

diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
index 0c7c9656da..8307a0d704 100644
--- a/docs/formatdomain.html.in
+++ b/docs/formatdomain.html.in
@@ -1388,7 +1388,7 @@ qemu-kvm -net nic,model=? /dev/null
       &lt;source network='default'/&gt;
       &lt;target dev='vnet1'/&gt;
       &lt;model type='virtio'/&gt;
-      <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