[libvirt PATCH 0/2] docs: small fixes to audio docs
Daniel P. Berrangé (2): docs: tweak heading name for <audio> element docs: add missing docs for some sound devices docs/formatdomain.rst | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) -- 2.31.1
The <audio> element is configuring exclusively a backend, not a device. Signed-off-by: Daniel P. Berrangé <berrange@redhat.com> --- docs/formatdomain.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst index afee69ac97..c18d802f18 100644 --- a/docs/formatdomain.rst +++ b/docs/formatdomain.rst @@ -6910,8 +6910,8 @@ ID is specified, then the default audio backend will be used. :anchor:`<a id="elementsAudio"/>` -Audio devices -~~~~~~~~~~~~~ +Audio backends +~~~~~~~~~~~~~~ A virtual audio device corresponds to a host audio backend that is mapped to the guest sound device. -- 2.31.1
On Fri, Jun 04, 2021 at 12:12:34 +0100, Daniel P. Berrangé wrote:
The <audio> element is configuring exclusively a backend, not a device.
Signed-off-by: Daniel P. Berrangé <berrange@redhat.com> --- docs/formatdomain.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
Reviewed-by: Peter Krempa <pkrempa@redhat.com>
Closes: https://gitlab.com/libvirt/libvirt/-/issues/173 Signed-off-by: Daniel P. Berrangé <berrange@redhat.com> --- docs/formatdomain.rst | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst index c18d802f18..89f677048d 100644 --- a/docs/formatdomain.rst +++ b/docs/formatdomain.rst @@ -6864,13 +6864,15 @@ A virtual sound card can be attached to the host via the ``sound`` element. ``sound`` The ``sound`` element has one mandatory attribute, ``model``, which specifies what real sound device is emulated. Valid values are specific to the - underlying hypervisor, though typical choices are 'es1370', 'sb16', 'ac97', - 'ich6' and 'usb'. ( :since:`'ac97' only since 0.6.0, 'ich6' only since - 0.8.8, 'usb' only since 1.2.7` ) - -:since:`Since 0.9.13` , a sound element with ``ich6`` model can have optional -sub-elements ``<codec>`` to attach various audio codecs to the audio device. If -not specified, a default codec will be attached to allow playback and recording. + underlying hypervisor, though typical choices are 'sb16', 'es1370', 'pcspk', + 'ac97' (:since:`Since 0.6.0`), 'ich6' (:since:`Since 0.8.8`), 'ich9' + (:since:`Since 1.1.2`), 'usb' (:since:`Since 1.2.7`) and 'ich7' + (:since:`Since 6.6.1`, bhyve only). + +:since:`Since 0.9.13` , a sound element with ``ich6`` or ``ich9`` models can have +optional sub-elements ``<codec>`` to attach various audio codecs to the audio +device. If not specified, a default codec will be attached to allow playback +and recording. Valid values are: -- 2.31.1
On Fri, Jun 04, 2021 at 12:12:35 +0100, Daniel P. Berrangé wrote:
Closes: https://gitlab.com/libvirt/libvirt/-/issues/173 Signed-off-by: Daniel P. Berrangé <berrange@redhat.com> --- docs/formatdomain.rst | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-)
diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst index c18d802f18..89f677048d 100644 --- a/docs/formatdomain.rst +++ b/docs/formatdomain.rst @@ -6864,13 +6864,15 @@ A virtual sound card can be attached to the host via the ``sound`` element. ``sound`` The ``sound`` element has one mandatory attribute, ``model``, which specifies what real sound device is emulated. Valid values are specific to the - underlying hypervisor, though typical choices are 'es1370', 'sb16', 'ac97', - 'ich6' and 'usb'. ( :since:`'ac97' only since 0.6.0, 'ich6' only since - 0.8.8, 'usb' only since 1.2.7` ) - -:since:`Since 0.9.13` , a sound element with ``ich6`` model can have optional -sub-elements ``<codec>`` to attach various audio codecs to the audio device. If -not specified, a default codec will be attached to allow playback and recording. + underlying hypervisor, though typical choices are 'sb16', 'es1370', 'pcspk',
These would probably look better when formatted as verbatim/code with double backticks, but that's a pre-existing problem.
+ 'ac97' (:since:`Since 0.6.0`), 'ich6' (:since:`Since 0.8.8`), 'ich9' + (:since:`Since 1.1.2`), 'usb' (:since:`Since 1.2.7`) and 'ich7'
off-by one: $ git describe --contains b83d26f6c434f80c71a2a7a0823b1ec16b798ca3 v1.1.3-rc1~45 $ git describe --contains e260a0e60a5 v1.2.8-rc1~223
+ (:since:`Since 6.6.1`, bhyve only).
$ git describe --contains 94995217180 v6.7.0-rc1~40
+ +:since:`Since 0.9.13` , a sound element with ``ich6`` or ``ich9`` models can have +optional sub-elements ``<codec>`` to attach various audio codecs to the audio +device. If not specified, a default codec will be attached to allow playback +and recording.
Reviewed-by: Peter Krempa <pkrempa@redhat.com>
participants (2)
-
Daniel P. Berrangé -
Peter Krempa