[libvirt] [PATCH] docs: add a note that spice channel is ignoret without spice graphics

[Pavel Hrdina]

On Thu, Feb 26, 2015 at 03:05:02PM +0100, Martin Kletzander wrote:
> On Thu, Feb 26, 2015 at 12:09:57PM +0100, Pavel Hrdina wrote:
> >To prevent a confusion about missing chardev argument in qemu
> >command line add a note about that behavior into documentation.
> >
> >Signed-off-by: Pavel Hrdina <phrdina at redhat.com>
> >---
> > docs/formatdomain.html.in | 4 ++++
> > 1 file changed, 4 insertions(+)
> >
> >diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
> >index fb0a0d1..cd179a6 100644
> >--- a/docs/formatdomain.html.in
> >+++ b/docs/formatdomain.html.in
> >@@ -5372,6 +5372,10 @@ qemu-kvm -net nic,model=? /dev/null
> >       under a channel name specified in the <code>channel</code>
> >       attribute.  <span class="since">Since 1.2.2</span>
> >     </p>
> >+    <p>
> >+      NOTE: if spice graphics is not defined the spice channel will
> >+      be ignored.
> >+    </p>
> >
> 
> This is misleading.  We don't ignore the XML element, we do the
> opposite.  We parse it and keep the info so that if someone
> experimenting with spice graphics does not loose the info.  We just
> don't use it on QEMU command-line.  This note should be and
> hypervisor-agnostic.  I'd suggest going with something like:

I agree that it might be misleading.

> 
>   Note: in order for the spiceport to be usable, the domain must have
>   spice graphics as well.
> 
> or:
> 
>   Note: depending on the hypervisor, spiceports might (or might not)
>   be enabled on domains with without <a href="#elementsGraphics">spice
>   graphics</a>.
> 

Thanks for review and suggestions, I'll post a v2.

> > <pre>
> >   ...
> >--
> >2.0.5
> >
> >--
> >libvir-list mailing list
> >libvir-list at redhat.com
> >https://www.redhat.com/mailman/listinfo/libvir-list