Re: [libvirt PATCH 2/2] docs: add missing docs for some sound devices

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



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@xxxxxxxxxx>
> ---
>  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@xxxxxxxxxx>




[Index of Archives]     [Virt Tools]     [Libvirt Users]     [Lib OS Info]     [Fedora Users]     [Fedora Desktop]     [Fedora SELinux]     [Big List of Linux Books]     [Yosemite News]     [KDE Users]     [Fedora Tools]

  Powered by Linux