Add documentation for <sound> device XML format.

diff --git a/ChangeLog b/ChangeLog
index 884dab9fba2ecb1d9d26d7c36cb09f466c793e10..5841278d56c6633c209a13dc5674337780b3f7b5 100644 (file)
--- 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 17dc0cd8e7456a4f82831c47de067d71a54ab4d0..27e42acb17beb178cafef1d87b13965367d5c2d1 100644 (file)
--- 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 ee32354cadbe13dfb27f2602e9103d697b0cd800..4479a6eef1186cb60d562791e20aca4884cba39a 100644 (file)
--- a/docs/formatdomain.html.in
+++ b/docs/formatdomain.html.in
@@ -886,6 +886,30 @@ qemu-kvm -net nic,model=? /dev/null
       </serial>
       ...</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>