[libvirt] [PATCH] docs: Document some -boot option limitations on UEFI

[Michal Privoznik]

It was brought to my attention that some -boot options may not
work with UEFI. For instance, rebootTimeout is very SeaBIOS
specific,splash logo is not implemented yet on OVMF, and so on.
We should document this limitation at least.

Signed-off-by: Michal Privoznik <mprivozn at redhat.com>
---
 docs/formatdomain.html.in | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
index 499879e..a35316e 100644
--- a/docs/formatdomain.html.in
+++ b/docs/formatdomain.html.in
@@ -174,6 +174,18 @@
         elements are mutually exclusive. <span class="since">Since 0.1.3,
         per-device boot since 0.8.8</span>
       </dd>
+  </dl>
+      <p>Up till here the BIOS/UEFI configuration knobs are generic enough to
+      be implemented by majority (if not all) firmwares out there. However,
+      from now on not every single setting makes sense to all firmwares. For
+      instance, <code>rebootTimeout</code> doesn't make sense for UEFI,
+      <code>useserial</code> might not be usable with a BIOS firmware that
+      doesn't produce any output onto serial line, etc. Moreover, firmwares
+      don't usually export their capabilities for libvirt (or users) to check.
+      And the set of their capabilities can change with every new release.
+      Hence users are advised to try the settings they use before relying on
+      them in production.</p>
+  <dl>
       <dt><code>bootmenu</code></dt>
       <dd> Whether or not to enable an interactive boot menu prompt on guest
       startup. The <code>enable</code> attribute can be either "yes" or "no".
-- 
2.0.5