[libvirt] [PATCH 3/8] docs: Reformat the Controllers description
Reformat to use <dt> elements to make it a bit easier to read.
Signed-off-by: John Ferlan <jferlan(a)redhat.com>
---
docs/formatdomain.html.in | 49 ++++++++++++++++++++++++++++-------------------
1 file changed, 29 insertions(+), 20 deletions(-)
diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
index 9d7e908..bcb8159 100644
--- a/docs/formatdomain.html.in
+++ b/docs/formatdomain.html.in
@@ -3007,28 +3007,37 @@
<p>
Each controller has a mandatory attribute <code>type</code>,
- which must be one of "ide", "fdc", "scsi",
"sata", "usb",
- "ccid", "virtio-serial" or "pci", and a mandatory
+ which must be one of 'ide', 'fdc', 'scsi', 'sata',
'usb',
+ 'ccid', 'virtio-serial' or 'pci', and a mandatory
attribute <code>index</code> which is the decimal integer
describing in which order the bus controller is encountered (for
- use in <code>controller</code> attributes
- of <code><address></code> elements). The
"virtio-serial"
- controller has two additional optional
- attributes <code>ports</code> and <code>vectors</code>,
which
- control how many devices can be connected through the
- controller. A "scsi" controller has an optional
- attribute <code>model</code>, which is one of "auto",
"buslogic",
- "ibmvscsi", "lsilogic", "lsisas1068",
"lsisas1078", "virtio-scsi" or
- "vmpvscsi". A "usb" controller has an optional attribute
- <code>model</code>, which is one of "piix3-uhci",
"piix4-uhci", "ehci",
- "ich9-ehci1", "ich9-uhci1", "ich9-uhci2",
"ich9-uhci3", "vt82c686b-uhci",
- "pci-ohci" or "nec-xhci". Additionally,
- <span class="since">since 0.10.0</span>, if the USB bus needs
to be
- explicitly disabled for the guest, <code>model='none'</code>
may be
- used. <span class="since">Since 1.0.5</span>, no default USB
controller
- will be built on s390. The PowerPC64 "spapr-vio" addresses do not have
an
- associated controller.
- </p>
+ use in <code>controller</code> attributes of
+ <code><address></code> elements). Some controller types
+ have additional attributes that control specific features, such as:
+ </p>
+
+ <dl>
+ <dt><code>type='virtio-serial'</code></dt>
+ <dd>The <code>virtio-serial</code> controller has two
additional
+ optional attributes <code>ports</code> and
<code>vectors</code>,
+ which control how many devices can be connected through the
+ controller.</dd>
+ <dt><code>type='scsi'</code></dt>
+ <dd>A <code>scsi</code> controller has an optional attribute
+ <code>model</code>, which is one of 'auto',
'buslogic', 'ibmvscsi',
+ 'lsilogic', 'lsisas1068', 'lsisas1078',
'virtio-scsi' or
+ 'vmpvscsi'.</dd>
+ <dt><code>type='usb'</code></dt>
+ <dd>A <code>usb</code> controller has an optional attribute
+ <code>model</code>, which is one of "piix3-uhci",
"piix4-uhci",
+ "ehci", "ich9-ehci1", "ich9-uhci1",
"ich9-uhci2", "ich9-uhci3",
+ "vt82c686b-uhci", "pci-ohci" or "nec-xhci".
Additionally,
+ <span class="since">since 0.10.0</span>, if the USB bus
needs to
+ be explicitly disabled for the guest,
<code>model='none'</code>
+ may be used. <span class="since">Since 1.0.5</span>, no
default
+ USB controller will be built on s390. The PowerPC64 "spapr-vio"
+ addresses do not have an associated controller.</dd>
+ </dl>
<p>
For controllers that are themselves devices on a PCI or USB bus,
--
2.5.5