From: Marc-André Lureau <marcandre.lureau@gmail.com>
Date: Thu, 2 Apr 2015 16:41:33 +0000 (+0200)
Subject: docs: add domain vmport feature
X-Git-Url: http://xenbits.xensource.com/gitweb?a=commitdiff_plain;h=208abbcbd7b7225d4506cfbb230cb2cb3fce87f8;p=people%2Fliuw%2Flibxenctrl-split%2Flibvirt.git

docs: add domain vmport feature

A new feature that can be turned on or off.

The QEMU machine vmport option allows to set the VMWare IO port
emulation. This emulation is useful for absolute pointer input when the
guest has vmware input drivers, and is enabled by default for kvm.

However it is unnecessary for Spice-enabled VM, since the agent already
handles absolute pointer and multi-monitors. Furthermore, it prevents
Spice from switching to relative input since the regular ps/2 pointer
driver is replaced by the vmware driver. It is thus advised to disable
vmport when using a Spice VM. This will permit the Spice client to
switch from absolute to relative pointer, as it may be required for
certain games or applications.
---

diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
index 0767a2a07..d48415293 100644
--- a/docs/formatdomain.html.in
+++ b/docs/formatdomain.html.in
@@ -1539,6 +1539,12 @@
         performance monitoring unit for the guest.
         <span class="since">Since 1.2.12</span>
       </dd>
+      <dt><code>vmport</code></dt>
+      <dd>Depending on the <code>state</code> attribute (values <code>on</code>,
+        <code>off</code>, default <code>on</code>) enable or disable
+        the emulation of VMWare IO port, for vmmouse etc.
+        <span class="since">Since 1.2.16</span>
+      </dd>
     </dl>
 
     <h3><a name="elementsTime">Time keeping</a></h3>
diff --git a/docs/schemas/domaincommon.rng b/docs/schemas/domaincommon.rng
index 7072954ac..64d22eaf2 100644
--- a/docs/schemas/domaincommon.rng
+++ b/docs/schemas/domaincommon.rng
@@ -4026,6 +4026,15 @@
           <optional>
             <ref name="pmu"/>
           </optional>
+          <optional>
+            <element name="vmport">
+              <optional>
+                <attribute name="state">
+                  <ref name="virOnOff"/>
+                </attribute>
+              </optional>
+            </element>
+          </optional>
         </interleave>
       </element>
     </optional>