From: Tim Wiederhake <twiederh@redhat.com>
Date: Thu, 25 Nov 2021 18:57:49 +0000 (+0100)
Subject: docs: domain: Add documentation for "hyperv"'s new "mode" attribute
X-Git-Tag: v8.0.0-rc1~182
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=da9f79844527d099de0cadcbafb53b307f5a72d2;p=thirdparty%2Flibvirt.git

docs: domain: Add documentation for "hyperv"'s new "mode" attribute

Signed-off-by: Tim Wiederhake <twiederh@redhat.com>
Reviewed-by: Ján Tomko <jtomko@redhat.com>
---

diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst
index 097796df72..717f2621e2 100644
--- a/docs/formatdomain.rst
+++ b/docs/formatdomain.rst
@@ -1820,7 +1820,7 @@ Hypervisors may allow certain CPU / machine features to be toggled on/off.
      <apic/>
      <hap/>
      <privnet/>
-     <hyperv>
+     <hyperv mode='custom'>
        <relaxed state='on'/>
        <vapic state='on'/>
        <spinlocks state='on' retries='4096'/>
@@ -1922,6 +1922,14 @@ are:
    evmcs           Enable Enlightened VMCS                                                on, off                                      :since:`4.10.0 (QEMU 3.1)`
    =============== ====================================================================== ============================================ =======================================================
 
+   :since:`Since 8.0.0` , the hypervisor can be configured further by setting
+   the ``mode`` attribute to one of the following values:
+
+   ``custom``
+      Set exactly the specified features.
+
+   The ``mode`` attribute can be omitted and will default to ``custom``.
+
 ``pvspinlock``
    Notify the guest that the host supports paravirtual spinlocks for example by
    exposing the pvticketlocks mechanism. This feature can be explicitly disabled