From a50fb7dadac961f640f7c43a2a7c28b809dc9b97 Mon Sep 17 00:00:00 2001 From: Andrea Bolognani Date: Tue, 14 Feb 2023 17:38:10 +0100 Subject: [PATCH] docs: Document firmware format attribute Signed-off-by: Andrea Bolognani Reviewed-by: Michal Privoznik --- docs/formatdomain.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst index 978c979c02..c4077c6868 100644 --- a/docs/formatdomain.rst +++ b/docs/formatdomain.rst @@ -257,6 +257,12 @@ harddisk, cdrom, network) determining where to obtain/find the boot image. any config changes on shutdown. The ``stateless`` flag (:since:`Since 8.6.0`) can be used to control this behaviour, when set to ``yes`` NVRAM will never be created. + + When firmware autoselection is enabled, the ``format`` attribute can be + used to tell libvirt to only consider firmware builds that are in a + specific format. Supported values are ``raw`` and ``qcow2``. + :since:`Since 9.2.0 (QEMU only)` + ``nvram`` Some UEFI firmwares may want to use a non-volatile memory to store some variables. In the host, this is represented as a file and the absolute path @@ -276,6 +282,10 @@ harddisk, cdrom, network) determining where to obtain/find the boot image. **Note:** ``network`` backed NVRAM the variables are not instantiated from the ``template`` and it's user's responsibility to provide a valid NVRAM image. + This element supports a ``format`` attribute, which has the same semantics + as the attribute of the same name for the ```` element. + :since:`Since 9.2.0 (QEMU only)` + It is not valid to provide this element if the loader is marked as stateless.