]> git.ipfire.org Git - thirdparty/libvirt.git/commitdiff
docs: improve description of secure attribute for loader element
authorPavel Hrdina <phrdina@redhat.com>
Tue, 16 Mar 2021 12:05:08 +0000 (13:05 +0100)
committerPavel Hrdina <phrdina@redhat.com>
Thu, 18 Mar 2021 17:41:32 +0000 (18:41 +0100)
The original text was not explaining what this attribute actually
controls and could have been interpreted as a control switch for the
Secure boot feature in firmwares.

Signed-off-by: Pavel Hrdina <phrdina@redhat.com>
Reviewed-by: Kashyap Chamarthy <kchamart@redhat.com>
Reviewed-by: Michal Privoznik <mprivozn@redhat.com>
docs/formatdomain.rst

index a2ea2690a5cc7c0a84911c265ed8b1a6e13a4fa1..70709ef9467c361c99d98af446536abf37f142ba 100644 (file)
@@ -167,7 +167,9 @@ harddisk, cdrom, network) determining where to obtain/find the boot image.
    in the guest memory the file should be mapped. For instance, if the loader
    path points to an UEFI image, ``type`` should be ``pflash``. Moreover, some
    firmwares may implement the Secure boot feature. Attribute ``secure`` can be
-   used then to control it. :since:`Since 2.1.0`
+   used to tell the hypervisor that the firmware is capable of Secure Boot feature.
+   It cannot be used to enable or disable the feature itself in the firmware.
+   :since:`Since 2.1.0`
 ``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