]> xenbits.xensource.com Git - libvirt.git/commitdiff
docs: add a note that attr 'managed' is only used by PCI devices
authorErik Skultety <eskultet@redhat.com>
Fri, 27 Feb 2015 11:45:57 +0000 (12:45 +0100)
committerMartin Kletzander <mkletzan@redhat.com>
Mon, 2 Mar 2015 09:47:06 +0000 (10:47 +0100)
Our documentation isn't 100% clear about hostdev 'managed' attribute usage,
because it only makes sense to use it with PCI devices, yet we format
this attribute to all hostdev devices. By adding a note into the docs,
we can possibly avoid confusion from customer's side and also avoid a solution
using ternary logic.

Resolves: https://bugzilla.redhat.com/show_bug.cgi?id=1155887

docs/formatdomain.html.in

index fb0a0d14c94bad7532a9c99f8fd2934a18305d5e..6276a615f21a559c973b146403a498139bbcf93d 100644 (file)
             then this setting not required.
           </dd>
         </dl>
+        <p>
+          Note: The <code>managed</code> attribute is only used with PCI devices
+          and is ignored by all the other device types, thus setting
+          <code>managed</code> explicitly with other than PCI device has the same
+          effect as omitting it.
+        </p>
       </dd>
       <dt><code>source</code></dt>
       <dd>The source element describes the device as seen from the host using