External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2025-02-21 19:02:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Document the new XML elements

Browse Source
This commit is contained in:
Andrea Bolognani 2016-04-18 19:20:07 +02:00
parent c9458b6583
commit eab0fda2ec
2 changed files with 44 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/formatdomain.html.in
View File

@ -1497,7 +1497,8 @@
All features are listed within the <code>features</code>
element, omitting a togglable feature tag turns it off.
The available features can be found by asking
for the <a href="formatcaps.html">capabilities XML</a>,
for the <a href="formatcaps.html">capabilities XML</a> and
<a href="formatdomaincaps.html">domain capabilities XML</a>,
but a common set for fully virtualized domains are:
</p>

43
docs/formatdomaincaps.html.in
View File

@ -145,7 +145,7 @@
<h3><a name="elementsDevices">Devices</a></h3>
<p>
The final set of XML elements describe the supported devices and their
Another set of XML elements describe the supported devices and their
capabilities. All devices occur as children of the main
<code>devices</code> element.
</p>
@ -277,5 +277,46 @@
<dd>Options for the <code>name</code> attribute of the &lt;driver/&gt;
element.</dd>
</dl>
<h3><a name="elementsFeatures">Features</a></h3>
<p>One more set of XML elements describe the supported features and
their capabilities. All features occur as children of the main
<code>features</code> element.</p>
<pre>
&lt;domainCapabilities&gt;
...
&lt;features&gt;
&lt;gic supported='yes'&gt;
&lt;enum name='version'&gt;
&lt;value&gt;2&lt;/value&gt;
&lt;value&gt;3&lt;/value&gt;
&lt;/enum&gt;
&lt;/gic&gt;
&lt;/features&gt;
&lt;/domainCapabilities&gt;
</pre>
<p>Reported capabilities are expressed as an enumerated list of
possible values for each of the elements or attributes. For example, the
<code>gic</code> element has an attribute <code>version</code> which can
support the values <code>2</code> or <code>3</code>.</p>
<p>For information about the purpose of each feature, see the
<a href="formatdomain.html#elementsFeatures">relevant section</a> in
the domain XML documentation.
</p>
<h4><a name="elementsGIC">GIC capabilities</a></h4>
<p>GIC capabilities are exposed under the <code>gic</code> element.</p>
<dl>
<dt>version</dt>
<dd>Options for the <code>version</code> attribute of the
<code>gic</code> element.</dd>
</dl>
</body>
</html>