On 08/05/2018 03:48 PM, Marek Marczykowski-Górecki wrote:
Specifically, list sub-elements and where they can be used. In addition,
describe supported machine types for Xen.
Signed-off-by: Marek Marczykowski-Górecki <marmarek@xxxxxxxxxxxxxxxxxxxxxx>
---
docs/formatcaps.html.in | 20 +++++++++++++++++++-
docs/formatdomain.html.in | 8 ++++----
2 files changed, 23 insertions(+), 5 deletions(-)
diff --git a/docs/formatcaps.html.in b/docs/formatcaps.html.in
index 41a9a3a..34a74a9 100644
--- a/docs/formatcaps.html.in
+++ b/docs/formatcaps.html.in
@@ -91,7 +91,25 @@
</dd>
<dt><code>arch</code></dt>
- <dd>This element brings some information on supported guest architecture.</dd>
+ <dd>This element brings some information on supported guest
+ architecture. Possible subelements are:
+ <dl>
+ <dt><code>wordsize</code></dt><dd>Size of CPU word in bits, for example 64.</dd>
+ <dt><code>emulator</code></dt><dd>Emulator (device model) path, for
+ use in <a href="formatdomain.html#elementEmulator">emulator</a>
+ element of domain XML.</dd>
+ <dt><code>loader</code></dt><dd>Loader path, for use in
+ <a href="formatdomain.html#elementLoader">loader</a> element of domain
+ XML.</dd>
+ <dt><code>machine</code></dt><dd>Machine type, for use in
+ <a href="formatdomain.html#attributeOSTypeMachine">machine</a>
+ attribute of os/type element in domain XML. For example Xen
+ supports <code>xenfv</code> for HVM or <code>xenpv</code> for
+ PV.</dd>
+ <dt><code>domain</code></dt><dd>Supported domain type, named by the
+ <code>type</code> attribute.</dd>
This last one wasn't very clear to me at first reading. What do you think of
rewording it to the following?
<dt><code>domain</code></dt><dd>The <code>type</code> attribute of
this element specifies the type of hypervisor required to run the
domain.</dd>
Similar to the other descriptions it would be nice to have a "for use in"
reference to the domain@type attribute.
Regards,
Jim
+ </dl>
+ </dd>
<dt><code>features</code></dt>
<dd>This optional element encases possible features that can be used
diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
index 8043c7c..9a342b2 100644
--- a/docs/formatdomain.html.in
+++ b/docs/formatdomain.html.in
@@ -148,11 +148,11 @@
refers to an OS that supports the Xen 3 hypervisor
guest ABI. There are also two optional attributes, <code>arch</code>
specifying the CPU architecture to virtualization,
- and <code>machine</code> referring to the machine
- type. The <a href="formatcaps.html">Capabilities XML</a>
+ and <a id="attributeOSTypeMachine"><code>machine</code></a> referring
+ to the machine type. The <a href="formatcaps.html">Capabilities XML</a>
provides details on allowed values for
these. <span class="since">Since 0.0.1</span></dd>
- <dt><code>loader</code></dt>
+ <dt><a id="elementLoader"><code>loader</code></a></dt>
<dd>The optional <code>loader</code> tag refers to a firmware blob,
which is specified by absolute path,
used to assist the domain creation process. It is used by Xen
@@ -2560,7 +2560,7 @@
...</pre>
<dl>
- <dt><code>emulator</code></dt>
+ <dt><a id="elementEmulator"><code>emulator</code></a></dt>
<dd>
The contents of the <code>emulator</code> element specify
the fully qualified path to the device model emulator binary.
--
libvir-list mailing list
libvir-list@xxxxxxxxxx
https://www.redhat.com/mailman/listinfo/libvir-list
