[libvirt PATCH 1/3] docs: split example for <os> schema
The docs illustration for the <os> schema contains a mixture of
incompatible configuration options. This is rather confusing and
misleading to users. Splitting the illustration into four separate
examples clarifies the situation.
Signed-off-by: Daniel P. Berrangé <berrange(a)redhat.com>
---
docs/formatdomain.rst | 32 +++++++++++++++++++++++++++++---
1 file changed, 29 insertions(+), 3 deletions(-)
diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst
index d4f30bb8af..3dee28d52a 100644
--- a/docs/formatdomain.rst
+++ b/docs/formatdomain.rst
@@ -110,12 +110,19 @@ harddisk, cdrom, network) determining where to obtain/find the boot
image.
::
+ <!-- Xen with fullvirt loader -->
...
- <os firmware='efi'>
+ <os>
<type>hvm</type>
- <loader readonly='yes' secure='no'
type='rom'>/usr/lib/xen/boot/hvmloader</loader>
- <nvram
template='/usr/share/OVMF/OVMF_VARS.fd'>/var/lib/libvirt/nvram/guest_VARS.fd</nvram>
+ <loader>/usr/lib/xen/boot/hvmloader</loader>
<boot dev='hd'/>
+ </os>
+ ...
+
+ <!-- QEMU with default firmware, serial console and SMBIOS -->
+ ...
+ <os>
+ <type>hvm</type>
<boot dev='cdrom'/>
<bootmenu enable='yes' timeout='3000'/>
<smbios mode='sysinfo'/>
@@ -123,6 +130,25 @@ harddisk, cdrom, network) determining where to obtain/find the boot
image.
</os>
...
+ <!-- QEMU with UEFI manual firmware and secure boot -->
+ ...
+ <os>
+ <type>hvm</type>
+ <loader readonly='yes' secure='yes'
type='pflash'>/usr/share/OVMF/OVMF_CODE.fd</loader>
+ <nvram
template='/usr/share/OVMF/OVMF_VARS.fd'>/var/lib/libvirt/nvram/guest_VARS.fd</nvram>
+ <boot dev='hd'/>
+ </os>
+ ...
+
+ <!-- QEMU with automatic UEFI firmware and secure boot -->
+ ...
+ <os firmware='efi'>
+ <type>hvm</type>
+ <loader secure='yes'/>
+ <boot dev='hd'/>
+ </os>
+ ...
+
``firmware``
The ``firmware`` attribute allows management applications to automatically
fill ``<loader/>`` and ``<nvram/>`` elements and possibly enable some
--
2.33.1