From b84a2cd87dad4a10e3a0064c30ac3df037048101 Mon Sep 17 00:00:00 2001
From: Martin Kletzander
Date: Mon, 13 Jul 2015 15:51:25 +0200
Subject: [PATCH] docs: Document how libvirt handles companion controllers
The information on companion controllers we give in our documentation is
rather sparse. For example, it looks like any controller can be used as
a companion one. Also, when using ich9-uhci2, for example, we are able
to set some sensible defaults, but it might get confusing for the user
as we don't do that for all controller models.
https://bugzilla.redhat.com/show_bug.cgi?id=1069590
Signed-off-by: Martin Kletzander
---
docs/formatdomain.html.in | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
index 8cd8d09d20..d0c1741050 100644
--- a/docs/formatdomain.html.in
+++ b/docs/formatdomain.html.in
@@ -3005,6 +3005,11 @@
relationship of the companion to its master controller.
A companion controller is on the same bus as its master, so
the companion index
value should be equal.
+ Not all controller models can be used as companion controllers
+ and libvirt might provide some sensible defaults (settings
+ of master startport
and function
of an
+ address) for some particular models.
+ Preferred companion controllers are ich-uhci[123]
.