[libvirt PATCH] docs: Clarify semantics of model/@usable attribute in dom caps

Jiri Denemark posted 1 patch 4 years ago
Test syntax-check failed
Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/libvirt tags/patchew/91562d21315add1ea206c38d6e0e9ffc42989cd1.1585340242.git.jdenemar@redhat.com
docs/formatdomaincaps.html.in | 8 +++++---
1 file changed, 5 insertions(+), 3 deletions(-)
[libvirt PATCH] docs: Clarify semantics of model/@usable attribute in dom caps
Posted by Jiri Denemark 4 years ago
The documentation could confuse people to expect that CPU models with
usable='no' attribute are not usable at all on the current host. But
they cannot be only used without explicitly disabling some features.

Signed-off-by: Jiri Denemark <jdenemar@redhat.com>
---
 docs/formatdomaincaps.html.in | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/docs/formatdomaincaps.html.in b/docs/formatdomaincaps.html.in
index 66e758501b..4056e0bd31 100644
--- a/docs/formatdomaincaps.html.in
+++ b/docs/formatdomaincaps.html.in
@@ -249,9 +249,11 @@
         The <code>mode</code> element contains a list of supported CPU
         models, each described by a dedicated <code>model</code> element.
         The <code>usable</code> attribute specifies whether the model can
-        be used on the host. A special value <code>unknown</code> indicates
-        libvirt does not have enough information to provide the usability
-        data.
+        be used directly on the host. When usable='no' the corresponding model
+        cannot be used without disabling some features that the CPU of such
+        model is expected to have. A special value <code>unknown</code>
+        indicates libvirt does not have enough information to provide the
+        usability data.
       </dd>
     </dl>
 
-- 
2.26.0

Re: [libvirt PATCH] docs: Clarify semantics of model/@usable attribute in dom caps
Posted by Andrea Bolognani 4 years ago
On Fri, 2020-03-27 at 21:17 +0100, Jiri Denemark wrote:
> The documentation could confuse people to expect that CPU models with
> usable='no' attribute are not usable at all on the current host. But
> they cannot be only used without explicitly disabling some features.
> 
> Signed-off-by: Jiri Denemark <jdenemar@redhat.com>
> ---
>  docs/formatdomaincaps.html.in | 8 +++++---
>  1 file changed, 5 insertions(+), 3 deletions(-)

Reviewed-by: Andrea Bolognani <abologna@redhat.com>

and safe for freeze.

-- 
Andrea Bolognani / Red Hat / Virtualization