[libvirt] [PATCH 7/7] docs: Document the new XML elements
---
docs/formatdomain.html.in | 3 ++-
docs/formatdomaincaps.html.in | 43 ++++++++++++++++++++++++++++++++++++++++++-
2 files changed, 44 insertions(+), 2 deletions(-)
diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
index 9bcef6a..54ad99b 100644
--- a/docs/formatdomain.html.in
+++ b/docs/formatdomain.html.in
@@ -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>
diff --git a/docs/formatdomaincaps.html.in b/docs/formatdomaincaps.html.in
index 850109f..0c40321 100644
--- a/docs/formatdomaincaps.html.in
+++ b/docs/formatdomaincaps.html.in
@@ -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
<driver/>
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>
+<domainCapabilities>
+ ...
+ <features>
+ <gic supported='yes'>
+ <enum name='version'>
+ <value>2</value>
+ <value>3</value>
+ </enum>
+ </gic>
+ </features>
+</domainCapabilities>
+</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>
--
2.5.5