From b509716b33047a6633a676870945b998b23d5421 Mon Sep 17 00:00:00 2001
From: Cole Robinson <crobinso@redhat.com>
Date: Tue, 19 May 2009 13:18:00 +0000
Subject: [PATCH] Add documentation for <sound> device XML format.

---
 ChangeLog                 |  5 +++++
 docs/formatdomain.html    | 20 ++++++++++++++++++++
 docs/formatdomain.html.in | 24 ++++++++++++++++++++++++
 3 files changed, 49 insertions(+)

diff --git a/ChangeLog b/ChangeLog
index 884dab9fba..5841278d56 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+Tue May 19 09:16:37 EDT 2009 Cole Robinson <crobinso@redhat.com>
+
+	Add documentation for <sound> device XML format.
+	* docs/formatdomain.html docs/formatdomain.html.in
+
 Tue May 19 09:14:12 EDT 2009 Cole Robinson <crobinso@redhat.com>
 
 	Use virAsprintf, rather than VIR_ALLOC + strcpy + strcat
diff --git a/docs/formatdomain.html b/docs/formatdomain.html
index 17dc0cd8e7..27e42acb17 100644
--- a/docs/formatdomain.html
+++ b/docs/formatdomain.html
@@ -183,6 +183,8 @@
                       </li><li>
                         <a href="#elementsCharUNIX">UNIX domain socket client/server</a>
                       </li></ul>
+                  </li><li>
+                    <a href="#elementsSound">Sound devices</a>
                   </li></ul>
               </li></ul>
           </li><li>
@@ -916,6 +918,24 @@ qemu-kvm -net nic,model=? /dev/null
         &lt;target port="1"/&gt;
       &lt;/serial&gt;
       ...</pre>
+        <h4>
+          <a name="elementsSound" id="elementsSound">Sound devices</a>
+        </h4>
+        <p>
+      A virtual sound card can be attached to the host via the
+      <code>sound</code> element. <span class="since">Since 0.4.3</span>
+    </p>
+        <pre>
+      ...
+      &lt;sound model='es1370'/&gt;
+      ...</pre>
+        <dl><dt><code>sound</code></dt><dd>
+        The <code>sound</code> element has one mandatory attribute,
+        <code>model</code>, which specifies what real sound device is emulated.
+        Valid values are specific to the underlying hypervisor, though typical
+        choices are 'es1370', 'sb16', and 'ac97'
+        (<span class="since">'ac97' only since 0.6.0</span>)
+      </dd></dl>
         <h2>
           <a name="examples" id="examples">Example configs</a>
         </h2>
diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
index ee32354cad..4479a6eef1 100644
--- a/docs/formatdomain.html.in
+++ b/docs/formatdomain.html.in
@@ -886,6 +886,30 @@ qemu-kvm -net nic,model=? /dev/null
       &lt;/serial&gt;
       ...</pre>
 
+
+    <h4><a name="elementsSound">Sound devices</a></h4>
+
+    <p>
+      A virtual sound card can be attached to the host via the
+      <code>sound</code> element. <span class="since">Since 0.4.3</span>
+    </p>
+
+    <pre>
+      ...
+      &lt;sound model='es1370'/&gt;
+      ...</pre>
+
+    <dl>
+      <dt><code>sound</code></dt>
+      <dd>
+        The <code>sound</code> element has one mandatory attribute,
+        <code>model</code>, which specifies what real sound device is emulated.
+        Valid values are specific to the underlying hypervisor, though typical
+        choices are 'es1370', 'sb16', and 'ac97'
+        (<span class="since">'ac97' only since 0.6.0</span>)
+      </dd>
+    </dl>
+
     <h2><a name="examples">Example configs</a></h2>
 
     <p>