diff --git a/docs/formatdomaincaps.html.in b/docs/formatdomaincaps.html.in index bc99d37856..0488d986ee 100644 --- a/docs/formatdomaincaps.html.in +++ b/docs/formatdomaincaps.html.in @@ -143,38 +143,51 @@ <domainCapabilities> -
The firmware
enum corresponds to
- firmware
attribute of the os
element.
- Plain presence of this enum means that libvirt is capable of so
- called firmware auto selection. The listed values then represent
- accepted values for the domain attribute. Only values for which
- there exists a firmware descriptor that matches machine type and
- architecture are listed, i.e. those which won't cause a failure
- on domain startup.
+
The firmware
enum corresponds to the
+ firmware
attribute of the os
element in
+ the domain XML. The presence of this enum means libvirt is capable
+ of the so-called firmware auto-selection feature. And the listed
+ firmware values represent the accepted input in the domain
+ XML. Note that the firmware
enum reports only those
+ values for which a firmware "descriptor file" exists on the host.
+ Firmware descriptor file is a small JSON document that describes
+ details about a given BIOS or UEFI binary on the host, e.g. the
+ fimware binary path, its architecture, supported machine types,
+ NVRAM template, etc. This ensures that the reported values won't
+ cause a failure on guest boot.
For the loader
element, the following can occur:
value
type
rom
) or
- an UEFI binary (pflash
). This refers to
- type
attribute of the <loader/>
- element.rom
)
+ or a UEFI firmware (pflash
). Each value
+ sub-element under the type
enum represents a possible
+ value for the type
attribute for the <loader/>
+ element in the domain XML. E.g. the presence
+ of pfalsh
under the type
enum means that
+ a domain XML can use UEFI firmware via: <loader/>
+ type="pflash" ...>/path/to/the/firmware/binary/</loader>.
+ readonly
readonly
attribute of the
- <loader/> element.secure
secure
attribute of the
- <loader/> element. Note, that yes
is listed
- only if there is a firmware that supports it.yes
is listed only if libvirt detects a
+ firmware descriptor file that has path to an OVMF binary that
+ supports Secure boot, and lists its architecture and supported
+ machine type.