Re: [libvirt] [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 <mkletzan(a)redhat.com&gt; --- docs/formatdomain.html.in | 5 +++++ 1 file changed, 5 insertions(+)

diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in index 8cd8d09d204c..d0c174105081 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 <code>index</code> value should be equal. + Not all controller models can be used as companion controllers + and libvirt might provide some sensible defaults (settings + of <code>master startport</code> and <code>function</code> of an + address) for some particular models. + Preferred companion controllers are <code>ich-uhci[123]</code>. </p> <pre>