[PATCH] docs: fix typo in domcaps host-model CPU description

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



The domain capabilities documentation contains a small but confusing
error in the host-model CPU description, referencing the element <mode>
instead of <model>. Fix this small typo.

Signed-off-by: Jim Fehlig <jfehlig@xxxxxxxx>
---

I only found this small typo (well, I'm pretty sure it's a typo :-)) by
tring to understand a more confusing observation. On a machine where
capabilities reports CascaseLake-Server, domcapabilities reports

    <mode name='host-model' supported='yes'>
      <model fallback='forbid'>Cascadelake-Server</model>
      <vendor>Intel</vendor>
      <feature policy='require' name='ss'/>
      <feature policy='require' name='hypervisor'/>
      <feature policy='require' name='tsc_adjust'/>
      <feature policy='require' name='umip'/>
      <feature policy='require' name='pku'/>
      <feature policy='require' name='md-clear'/>
      <feature policy='require' name='stibp'/>
      <feature policy='require' name='arch-capabilities'/>
      <feature policy='require' name='xsaves'/>
      <feature policy='require' name='invtsc'/>
    </mode>
    <mode name='custom' supported='yes'>
      ...
      <model usable='no'>Cascadelake-Server</model>
    </mode>

So using host-model will result in a CascadeLake-Server CPU, but it
is not supported when specifying a custom CPU? Interestingly, I see
something similar from domcapabilities on machine where capabilities
reports Skylake-Server-IBRS

    <mode name='host-model' supported='yes'>
      <model fallback='forbid'>Cascadelake-Server</model>
      <vendor>Intel</vendor>
      <feature policy='require' name='ss'/>
      <feature policy='require' name='hypervisor'/>
      <feature policy='require' name='tsc_adjust'/>
      <feature policy='require' name='umip'/>
      <feature policy='require' name='md-clear'/>
      <feature policy='require' name='stibp'/>
      <feature policy='require' name='arch-capabilities'/>
      <feature policy='require' name='xsaves'/>
      <feature policy='require' name='invtsc'/>
      <feature policy='disable' name='pku'/>
      <feature policy='disable' name='avx512vnni'/>
    </mode>
    <mode name='custom' supported='yes'>
      ...
      <model usable='no'>Skylake-Server-IBRS</model>
      <model usable='no'>Skylake-Server</model>
      <model usable='no'>Cascadelake-Server</model>
    </mode>

This seems contradictory to me but perhaps I'm overlooking something?

 docs/formatdomaincaps.html.in | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/docs/formatdomaincaps.html.in b/docs/formatdomaincaps.html.in
index 66e758501b..7fd1f91f73 100644
--- a/docs/formatdomaincaps.html.in
+++ b/docs/formatdomaincaps.html.in
@@ -232,7 +232,7 @@
       <dt><code>host-model</code></dt>
       <dd>
         If <code>host-model</code> is supported by the hypervisor, the
-        <code>mode</code> describes the guest CPU which will be used when
+        <code>model</code> describes the guest CPU which will be used when
         starting a domain with <code>host-model</code> CPU. The hypervisor
         specifics (such as unsupported CPU models or features, machine type,
         etc.) may be accounted for in this guest CPU specification and thus
-- 
2.25.0






[Index of Archives]     [Virt Tools]     [Libvirt Users]     [Lib OS Info]     [Fedora Users]     [Fedora Desktop]     [Fedora SELinux]     [Big List of Linux Books]     [Yosemite News]     [KDE Users]     [Fedora Tools]

  Powered by Linux