openkylin
/
libvirt
mirror of https://gitee.com/openkylin/libvirt.git
9
0
Fork 0
Code Issues Projects Releases Wiki Activity

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>
This commit is contained in:
Daniel P. Berrangé 2022-01-10 10:49:19 +00:00
parent 19407e8d7d
commit 08e3d9ed24
1 changed files with 29 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
docs/formatdomain.rst
View File

@ -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> <type>hvm</type>
<loader readonly='yes' secure='no' type='rom'>/usr/lib/xen/boot/hvmloader</loader> <loader>/usr/lib/xen/boot/hvmloader</loader>
<nvram template='/usr/share/OVMF/OVMF_VARS.fd'>/var/lib/libvirt/nvram/guest_VARS.fd</nvram>
<boot dev='hd'/> <boot dev='hd'/>
</os>
...
<!-- QEMU with default firmware, serial console and SMBIOS -->
...
<os>
<type>hvm</type>
<boot dev='cdrom'/> <boot dev='cdrom'/>
<bootmenu enable='yes' timeout='3000'/> <bootmenu enable='yes' timeout='3000'/>
<smbios mode='sysinfo'/> <smbios mode='sysinfo'/>
@ -123,6 +130,25 @@ harddisk, cdrom, network) determining where to obtain/find the boot image.
</os> </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`` ``firmware``
The ``firmware`` attribute allows management applications to automatically The ``firmware`` attribute allows management applications to automatically
fill ``<loader/>`` and ``<nvram/>`` elements and possibly enable some fill ``<loader/>`` and ``<nvram/>`` elements and possibly enable some