From: Kashyap Chamarthy <kchamart@redhat.com>
Date: Thu, 25 Jan 2018 09:09:01 +0000 (+0100)
Subject: docs: formatdomain: Document the CPU feature 'name' attribute
X-Git-Tag: v4.1.0-rc1~279
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=d449dbdcc026642ca8b26e7d1282eaecb400261f;p=thirdparty%2Flibvirt.git

docs: formatdomain: Document the CPU feature 'name' attribute

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@redhat.com>
---

diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
index f1fb8e59cc..3ec1173c6f 100644
--- a/docs/formatdomain.html.in
+++ b/docs/formatdomain.html.in
@@ -1521,6 +1521,21 @@
 
         <span class="since">Since 0.8.5</span> the <code>policy</code>
         attribute can be omitted and will default to <code>require</code>.
+
+        <p> Individual CPU feature names are specified as part of the
+        <code>name</code> attribute. For example, to explicitly specify
+        the 'pcid' feature with Intel IvyBridge CPU model:
+        </p>
+
+<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>