From: Daniel P. Berrangé <berrange@redhat.com>
Date: Mon, 10 Jan 2022 10:49:19 +0000 (+0000)
Subject: docs: split example for <os> schema
X-Git-Tag: v8.1.0-rc1~442
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=08e3d9ed24adcd92b8e9a4f66c054bb9a2ceb489;p=thirdparty%2Flibvirt.git

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.

Reviewed-by: Michal Privoznik <mprivozn@redhat.com>
Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
---

diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst
index 8128e43da4..c0b2d935f3 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