From d32a2f25bf939972592c4d924261aa89570de0cd Mon Sep 17 00:00:00 2001 From: John Ferlan Date: Thu, 21 Apr 2016 08:35:54 -0400 Subject: [PATCH] docs: Reformat the Controllers description Reformat to use
elements to make it a bit easier to read. Signed-off-by: John Ferlan --- docs/formatdomain.html.in | 56 ++++++++++++++++++++++++--------------- 1 file changed, 35 insertions(+), 21 deletions(-) diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in index 817d9c525f..d01a887cc5 100644 --- a/docs/formatdomain.html.in +++ b/docs/formatdomain.html.in @@ -3011,29 +3011,43 @@

Each controller has a mandatory attribute type, - 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 index which is the decimal integer describing in which order the bus controller is encountered (for - use in controller attributes - of <address> elements). The "virtio-serial" - controller has two additional optional - attributes ports and vectors, which - control how many devices can be connected through the - controller. A "scsi" controller has an optional - attribute model, which is one of "auto", "buslogic", - "ibmvscsi", "lsilogic", "lsisas1068", "lsisas1078", "virtio-scsi" or - "vmpvscsi". A "usb" controller has an optional attribute - model, 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, - since 0.10.0, if the USB bus needs to be - explicitly disabled for the guest, model='none' may be - used. Since 1.0.5, no default USB controller - will be built on S390. Since 1.3.5, USB - controllers accept a ports attribute to configure how - many devices can be connected to the controller. The PowerPC64 - "spapr-vio" addresses do not have an associated controller. + use in controller attributes of + <address> elements). Some controller types + have additional attributes that control specific features, such as: +

+ +
+
virtio-serial
+
The virtio-serial controller has two additional + optional attributes ports and vectors, + which control how many devices can be connected through the + controller.
+
scsi
+
A scsi controller has an optional attribute + model, which is one of 'auto', 'buslogic', 'ibmvscsi', + 'lsilogic', 'lsisas1068', 'lsisas1078', 'virtio-scsi' or + 'vmpvscsi'.
+
usb
+
A usb controller has an optional attribute + model, 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, + since 0.10.0, if the USB bus needs to + be explicitly disabled for the guest, model='none' + may be used. Since 1.0.5, no default + USB controller will be built on s390. + Since 1.3.5, USB controllers accept a + ports attribute to configure how many devices can be + connected to the controller.
+
+ +

+ Note: The PowerPC64 "spapr-vio" addresses do not have an + associated controller.