[libvirt] [PATCH] docs: Add doc for video element

[Eric Blake]

On 06/02/2011 03:45 AM, Osier Yang wrote:
> For backwards compatability, if no <video> is set but there is a

s/compatability/compatibility/

> <graphics> tag, then we add a default <video> according to the
> guest type. Add docs to tell the user about this to not make
> them confused. Especially if they remove the video (such as via
> "virsh edit"), it will be surprised for them to see the video
> element is still in domain XML.
> ---
>  docs/formatdomain.html.in |    7 ++++++-
>  1 files changed, 6 insertions(+), 1 deletions(-)
> 
> diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
> index f8baffd..455f4dd 100644
> --- a/docs/formatdomain.html.in
> +++ b/docs/formatdomain.html.in
> @@ -1868,7 +1868,12 @@ qemu-kvm -net nic,model=? /dev/null
>        <dt><code>video</code></dt>
>        <dd>
>          The <code>video</code> element is the a container for describing
> -        video devices.
> +        video devices. NB, for backwards compatability, if no <code>video</code>

When reading, I generally find that "NB" doesn't add much to the
conversation.  Also, this has a typo.  How about:

s/NB, for backwards compatability,/For backwards compatibility,/

> +        is set but there is a <code>graphics</code> in domain xml, then libvirt
> +        will add a default <code>video</code> according to the guest type, e.g.
> +        For a guest of type "kvm", the default <code>video</code> for it is:

s/type, e.g. For/type.  For/

ACK with those nits fixed, and since it is doc-only, pushing prior to
0.9.2 is desirable.

-- 
Eric Blake   eblake at redhat.com    +1-801-349-2682
Libvirt virtualization library http://libvirt.org

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 619 bytes
Desc: OpenPGP digital signature
URL: <http://listman.redhat.com/archives/libvir-list/attachments/20110603/e28316f3/attachment-0001.sig>