]> xenbits.xensource.com Git - libvirt.git/commitdiff
docs: Clarify semantics of model/@usable attribute in dom caps
authorJiri Denemark <jdenemar@redhat.com>
Fri, 27 Mar 2020 20:05:28 +0000 (21:05 +0100)
committerJiri Denemark <jdenemar@redhat.com>
Mon, 30 Mar 2020 08:52:07 +0000 (10:52 +0200)
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>
Reviewed-by: Andrea Bolognani <abologna@redhat.com>
docs/formatdomaincaps.html.in

index 66e758501b5d19025a396bb06ecb3ebdd19deff7..4056e0bd312736cf45a56d860befe4119365cbcd 100644 (file)
         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>