]> git.ipfire.org Git - thirdparty/libvirt.git/commitdiff
docs: Expand on recommendation in hypervisor-cpu-baseline description
authorTim Wiederhake <twiederh@redhat.com>
Fri, 9 Oct 2020 13:02:11 +0000 (15:02 +0200)
committerMichal Privoznik <mprivozn@redhat.com>
Thu, 15 Oct 2020 09:39:17 +0000 (11:39 +0200)
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.

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

Signed-off-by: Tim Wiederhake <twiederh@redhat.com>
Reviewed-by: Daniel Henrique Barboza <danielhb413@gmail.com>
docs/manpages/virsh.rst

index 8fee4c7afec3b95e2b2d4d7215fb31d2bead9a2f..d34a1c8684fdcceee216362c2f918c8f63d1dfb4 100644 (file)
@@ -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
-capabilities.
+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.