From: Pavel Hrdina <phrdina@redhat.com>
Date: Thu, 26 Feb 2015 10:59:41 +0000 (+0100)
Subject: docs: add a note that spice channel is usable only with spice graphics
X-Git-Tag: v1.2.14-rc1~227
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=242e8c54728abc464b92d55a5ce76121803c97e4;p=thirdparty%2Flibvirt.git

docs: add a note that spice channel is usable only with spice graphics

To prevent a confusion about missing chardev argument in qemu
command line add a note about that behavior into documentation.

Resolves: https://bugzilla.redhat.com/show_bug.cgi?id=1129198

Signed-off-by: Pavel Hrdina <phrdina@redhat.com>
---

diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
index 335763fdde..ede20de508 100644
--- a/docs/formatdomain.html.in
+++ b/docs/formatdomain.html.in
@@ -5380,6 +5380,11 @@ 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: depending on the hypervisor, spiceports might (or might not)
+      be enabled on domains with or without <a href="#elementsGraphics">spice
+      graphics</a>.
+    </p>
 
 <pre>
   ...