[PATCH] docs: formatdomain: Document the CPU feature 'name' attribute

[Kashyap Chamarthy <kchamart@xxxxxxxxxx>]

Currently, the CPU feature 'name' XML attribute, as in:

    [...]
    <cpu match='exact'>
      <model fallback='forbid'>IvyBridge</model>
      <vendor>Intel</vendor>
      <feature policy='require' name='pcid'/>
    </cpu>
    [...]

isn't explicitly documented in formatdomain.html.

Document it now.

Signed-off-by: Kashyap Chamarthy <kchamart@xxxxxxxxxx>
---
 docs/formatdomain.html.in | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
index d272cc1ba..e717fb3aa 100644
--- a/docs/formatdomain.html.in
+++ b/docs/formatdomain.html.in
@@ -1454,6 +1454,23 @@
 
         <span class="since">Since 0.8.5</span> the <code>policy</code>
         attribute can be omitted and will default to <code>require</code>.
+
+        Individual CPU feature names can be specified as part of the
+        <code>name</code> attribute. The list of known CPU feature
+        names (e.g. 'vmx', 'cmt', et cetera) can be found in the same
+        file as CPU models -- <code>cpu_map.xml</code>. For example,
+        to explicitly specify the 'pcid' feature with Intel IvyBridge
+        CPU model:
+
+<pre>
+...
+&lt;cpu match='exact'&gt;
+  &lt;model fallback='forbid'&gt;IvyBridge&lt;/model&gt;
+  &lt;vendor&gt;Intel&lt;/vendor&gt;
+  &lt;feature policy='require' name='pcid'/&gt;
+&lt;/cpu&gt;
+...</pre>
+
       </dd>
 
       <dt><code>cache</code></dt>
-- 
2.13.6

--
libvir-list mailing list
libvir-list@xxxxxxxxxx
https://www.redhat.com/mailman/listinfo/libvir-list