grub-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[PATCH v2 3/3] bli: Improve documentation


From: Oliver Steffen
Subject: [PATCH v2 3/3] bli: Improve documentation
Date: Wed, 15 Nov 2023 21:08:02 +0100

Improve the documentation of the bli module, explain in more detail what
it does. Make clear that GPT formatted drives are expected and other
partition formats are ignored.
Also reorder and reword this section a bit.

Signed-off-by: Oliver Steffen <osteffen@redhat.com>
---
 docs/grub.texi | 17 +++++++++++++----
 1 file changed, 13 insertions(+), 4 deletions(-)

diff --git a/docs/grub.texi b/docs/grub.texi
index 975e521d1..4b9ceceb7 100644
--- a/docs/grub.texi
+++ b/docs/grub.texi
@@ -3880,11 +3880,20 @@ Modules can be loaded via the @command{insmod} 
(@pxref{insmod}) command.
 @section bli
 This module provides basic support for the Boot Loader Interface. The Boot
 Loader Interface specifies a set of EFI variables that are used to communicate
-boot-time information between the boot loader and the operating system.
+boot-time information between the bootloader and the operating system.
 
-When loaded, the bli module publishes the GPT partition UUID of the EFI System
-Partition used during boot and a string identifying GRUB as the active boot
-loader, including the version number.
+The following variables are placed under the vendor UUID
+@code{4a67b082-0a4c-41cf-b6c7-440b29bb8c4f} when the module is loaded:
+
+The GPT partition UUID of the EFI System Partition used during boot is
+published via the @code{LoaderDevicePartUUID} variable. The Boot Loader
+Interface specification requires GPT formatted drives. The bli module ignores
+drives/partitions in any other format. If Grub is loaded from a non-GPT
+partition (for example from an MSDOS formatted drive, or the network)
+this variable will not be set.
+
+A string identifying GRUB as the active bootloader including the version
+number is stored in @code{LoaderInfo}.
 
 This module is only available on UEFI platforms.
 
-- 
2.41.0




reply via email to

[Prev in Thread] Current Thread [Next in Thread]