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

Kashyap Chamarthy posted 1 patch 6 years, 9 months ago
Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/libvirt tags/patchew/20180125090901.12927-1-kchamart@redhat.com
docs/formatdomain.html.in | 15 +++++++++++++++
1 file changed, 15 insertions(+)
[libvirt] [PATCH v3] docs: formatdomain: Document the CPU feature 'name' attribute
Posted by Kashyap Chamarthy 6 years, 9 months ago
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>
---
v3:
 - Wrap text in paragraph; fix phrasing [John Ferlan]
v2:
 - Remove redundant line [Eduardo Habkost]

 docs/formatdomain.html.in | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
index d272cc1ba..fc0885420 100644
--- a/docs/formatdomain.html.in
+++ b/docs/formatdomain.html.in
@@ -1454,6 +1454,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>
-- 
2.13.6

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list
Re: [libvirt] [PATCH v3] docs: formatdomain: Document the CPU feature 'name' attribute
Posted by Jiri Denemark 6 years, 9 months ago
On Thu, Jan 25, 2018 at 10:09:01 +0100, Kashyap Chamarthy wrote:
> 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>
> ---
> v3:
>  - Wrap text in paragraph; fix phrasing [John Ferlan]
> v2:
>  - Remove redundant line [Eduardo Habkost]
> 
>  docs/formatdomain.html.in | 15 +++++++++++++++
>  1 file changed, 15 insertions(+)

ACK

Jirka

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