Fix documentation of VIR_CONNECT_GET_DOMAIN_CAPABILITIES_EXPAND_CPU_FEATURES

The flag is designed for expanding the CPU model used by host-model. But
the documentation was sometimes describing it as showing all CPU
features supported on the host, which is wrong as the host may support
features that would not be enabled in host-model.

Signed-off-by: Jiri Denemark <jdenemar@redhat.com>
Reviewed-by: Peter Krempa <pkrempa@redhat.com>

diff --git a/docs/manpages/virsh.rst b/docs/manpages/virsh.rst
index d1901c82c2bdfa6e0d6906588ca1ef7b3ebd8022..9f888845df1bca6b17b0cf8cb39adb0142bd6e99 100644 (file)
--- a/docs/manpages/virsh.rst
+++ b/docs/manpages/virsh.rst
@@ -640,8 +640,9 @@ flagged as deprecated for the CPU model by the hypervisor. These
 features will be paired with the "disable" policy.
 
 The **--expand-cpu-features** option will cause the host-model CPU definition
-to contain all CPU features supported on the host including those implicitly
-enabled by the selected CPU model.
+to contain all required CPU features including those implicitly enabled by the
+selected CPU model. Without this flag features that are part of the CPU model
+itself will not be listed.
 
 
 pool-capabilities

diff --git a/src/libvirt-domain.c b/src/libvirt-domain.c
index a4cbeb8ad48696330182198388e70275014f297c..425a73e75ab39a560216efd6a7cc8dcee646fea1 100644 (file)
--- a/src/libvirt-domain.c
+++ b/src/libvirt-domain.c
@@ -12353,9 +12353,9 @@ virDomainSetUserPassword(virDomainPtr dom,
  * passthrough and so on.
  *
  * If @flags includes VIR_CONNECT_GET_DOMAIN_CAPABILITIES_EXPAND_CPU_FEATURES,
- * libvirt will explicitly list all CPU features (in host-model CPU definition)
- * that are supported on the host. Without this flag features that are part of
- * the CPU model itself will not be listed.
+ * libvirt will explicitly list all CPU features that will be enabled for
+ * host-model CPU mode. Without this flag features that are part of the CPU
+ * model itself will not be listed.
  *
  * Returns NULL in case of error or an XML string
  * defining the capabilities.

diff --git a/tools/virsh-host.c b/tools/virsh-host.c
index ef91e22fed3601f24ec651132d644d8f8c77fdcc..67aac365f254cd9774e4ccf910e53fa6ff7c3dd8 100644 (file)
--- a/tools/virsh-host.c
+++ b/tools/virsh-host.c
@@ -121,7 +121,7 @@ static const vshCmdOptDef opts_domcapabilities[] = {
     },
     {.name = "expand-cpu-features",
      .type = VSH_OT_BOOL,
-     .help = N_("show all features in host CPU model"),
+     .help = N_("expand 'host-model' CPU to also show features enabled by the CPU model"),
     },
     {.name = NULL}
 };