[libvirt] [PATCH 1/2] docs: mention more about older capability feature bits

Eric Blake eblake at redhat.com
Mon Jul 14 14:08:31 UTC 2014


Our documentation for features was rather sparse; this fleshes out
more of the details for other existing capabilities (and cost me
some time trawling git history).

* docs/formatcaps.html.in: Document it feature bits.

Signed-off-by: Eric Blake <eblake at redhat.com>
---
 docs/formatcaps.html.in | 42 +++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 41 insertions(+), 1 deletion(-)

diff --git a/docs/formatcaps.html.in b/docs/formatcaps.html.in
index 137af25..4245d8a 100644
--- a/docs/formatcaps.html.in
+++ b/docs/formatcaps.html.in
@@ -95,7 +95,47 @@

         <dt><code>features</code></dt>
         <dd>This optional element encases possible features that can be used
-        with a guest of described type.</dd>
+          with a guest of described type.  Possible subelements are:
+          <dl>
+            <dt>pae</dt><dd>If present, 32-bit guests can use PAE
+              address space extensions, <span class="since">since
+              0.4.1</span></dd>
+            <dt>nonpae</dt><dd>If present, 32-bit guests can be run
+              without requiring PAE, <span class="since">since
+              0.4.1</span></dd>
+            <dt>ia64_be</dt><dd>If present, IA64 guests can be run in
+              big-endian mode, <span class="since">since 0.4.1</span></dd>
+            <dt>acpi</dt><dd>If this element is present,
+              the <code>default</code> attribute describes whether the
+              hypervisor exposes ACPI to the guest by default, and
+              the <code>toggle</code> attribute describes whether the
+              user can override this
+              default. <span class="since">Since 0.4.1</span></dd>
+            <dt>apic</dt><dd>If this element is present,
+              the <code>default</code> attribute describes whether the
+              hypervisor exposes APIC to the guest by default, and
+              the <code>toggle</code> attribute describes whether the
+              user can override this
+              default. <span class="since">Since 0.4.1</span></dd>
+            <dt>cpuselection</dt><dd>If this element is present, the
+              hypervisor supports the <code><cpu></code> element
+              within a domain definition for fine-grained control over
+              the CPU presented to the
+              guest. <span class="since">Since 0.7.5</span></dd>
+            <dt>deviceboot</dt><dd>If this element is present,
+              the <code><boot order='...'/></code> element can
+              be used inside devices, rather than the older boot
+              specification by category. <span class="since">Since
+              0.8.8</span></dd>
+            <dt>disksnapshot</dt><dd>If this element is present,
+              the <code>default</code> attribute describes whether
+              external disk snapshots are supported.  If absent,
+              external snapshots may still be supported, but it
+              requires attempting the API and checking for an error to
+              find out for sure. <span class="since">Since
+              1.2.3</span></dd>
+          </dl>
+        </dd>
     </dl>

     <h3><a name="elementExamples">Examples</a></h3>
-- 
1.9.3




More information about the libvir-list mailing list