From: Olaf Hering <olaf@aepfle.de>
Date: Wed, 12 Jan 2022 12:42:00 +0000 (+0100)
Subject: docs: domain: document legacy audio for qemu
X-Git-Tag: v8.1.0-rc1~415
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=31d461f5752f64397a46125268f39d633698fb05;p=thirdparty%2Flibvirt.git

docs: domain: document legacy audio for qemu

Adding a blurb like this was forgotten in 2009.

Signed-off-by: Olaf Hering <olaf@aepfle.de>
Reviewed-by: Andrea Bolognani <abologna@redhat.com>
---

diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst
index c0b2d935f3..acd9020830 100644
--- a/docs/formatdomain.rst
+++ b/docs/formatdomain.rst
@@ -7105,6 +7105,20 @@ is permitted with the following attributes.
   The audio format, one of ``s8``, ``u8``, ``s16``, ``u16``,
   ``s32``, ``u32``, ``f32``. The default is hypervisor specific.
 
+Note:
+If no ``<audio/>`` element is defined, and the ``graphics`` element is set to
+either 'vnc' or 'sdl', the libvirtd or virtqemud process will honor the following
+environment variables:
+
+* ``SDL_AUDIODRIVER``
+
+  Valid values are 'pulseaudio', 'esd', 'alsa' or 'arts'.
+
+* ``QEMU_AUDIO_DRV``
+
+  Valid values are 'pa', 'none', 'alsa', 'coreaudio', 'jack', 'oss',
+  'sdl', 'spice' or 'wav'.
+
 None audio backend
 ^^^^^^^^^^^^^^^^^^