[libvirt PATCH] docs: Expand on recommendation in hypervisor-cpu-baseline description
twiederh at redhat.com
Fri Oct 9 13:02:11 UTC 2020
On some architectures, e.g. aarch64 and s390x, the output of
`virsh capabilities` is not suitable for use in
`virsh hypervisor-cpu-baseline`. Expand the description of the
man page to make this explicit.
Signed-off-by: Tim Wiederhake <twiederh at redhat.com>
docs/manpages/virsh.rst | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/docs/manpages/virsh.rst b/docs/manpages/virsh.rst
index 8fee4c7afe..d34a1c8684 100644
@@ -976,8 +976,9 @@ as printed by ``capabilities`` command. The guest CPU definition may be created
from the host CPU model found in domain capabilities XML (printed by
``domcapabilities`` command). In addition to the <cpu> elements, this command
accepts full capabilities XMLs, or domain capabilities XMLs containing the CPU
-definitions. For best results, use only the CPU definitions from domain
+definitions. It is recommended to use only the CPU definitions from domain
+capabilities, as on some architectures using the host CPU definition may either
+fail or provide unexpected results.
When *FILE* contains only a single CPU definition, the command will print the
same CPU with restrictions imposed by the capabilities of the hypervisor.
More information about the libvir-list