[libvirt PATCH] docs: Expand on recommendation in hypervisor-cpu-baseline description

Tim Wiederhake posted 1 patch 2 weeks ago
Test syntax-check failed
Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/libvirt tags/patchew/20201009130211.72618-1-twiederh@redhat.com
docs/manpages/virsh.rst | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)

[libvirt PATCH] docs: Expand on recommendation in hypervisor-cpu-baseline description

Posted by Tim Wiederhake 2 weeks ago
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>
---
 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
--- a/docs/manpages/virsh.rst
+++ b/docs/manpages/virsh.rst
@@ -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.
-- 
2.26.2

Re: [libvirt PATCH] docs: Expand on recommendation in hypervisor-cpu-baseline description

Posted by Daniel Henrique Barboza 1 week ago

On 10/9/20 10:02 AM, Tim Wiederhake wrote:
> 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 | 5 +++--
>   1 file changed, 3 insertions(+), 2 deletions(-)
> 
> diff --git a/docs/manpages/virsh.rst b/docs/manpages/virsh.rst
> index 8fee4c7afe..d34a1c8684 100644
> --- a/docs/manpages/virsh.rst
> +++ b/docs/manpages/virsh.rst
> @@ -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.
> 

Re: [libvirt PATCH] docs: Expand on recommendation in hypervisor-cpu-baseline description

Posted by Michal Privoznik 1 week ago
On 10/15/20 1:02 AM, Daniel Henrique Barboza wrote:
> 
> 
> On 10/9/20 10:02 AM, Tim Wiederhake wrote:
>> 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>

Pushed.

Michal