[PATCH] Documentation

7 views
Skip to first unread message

Sterling Archer

unread,
Aug 13, 2026, 3:11:30 PMAug 13
to EFI Boot Guard
From: Sterling Archer <wwqree...@gmail.com>

Very minor, but interchanged usage of "partition label" and "volume label" can confuse the meaning.

Hope I got the meaning correct with this patch.

Signed-off-by: Sterling Archer <wwqree...@gmail.com>
---
 docs/USAGE.md | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/docs/USAGE.md b/docs/USAGE.md
index 97a25cb..c0802b7 100644
--- a/docs/USAGE.md
+++ b/docs/USAGE.md
@@ -150,18 +150,18 @@ If you just specify a file name as `--kernelfile`, `efibootguard` loads the
 kernel from the same FAT partition as the boot loader binary itself.
 
 To load the kernel from a different FAT partition than `efibootguard`, there are
-two possible mechanisms. One directly uses the label of the FAT partition,
+two possible mechanisms. One directly uses the label of the FAT filesystem,
 created with `dosfslabel`:
 
 ```
 ./bg_setenv -u --kernel="L:FATLABEL:kernelfile"
 ```
 
-where `FATLABEL` is the label of the FAT partition. On some older UEFI
+where `FATLABEL` is the label of the FAT filesystem. On some older UEFI
 implementations, the label is not supported properly and a user defined label
 can be created instead, which is a file named `EFILABEL` in the root directory
 of the corresponding FAT partition. This file contains an UTF-16le encoded
-partition name and can be used as follows:
+filesystem name and can be used as follows:
 
 ```
 ./bg_setenv -u --kernel="C:USERLABEL:kernelfile"
--
2.54.0

Jan Kiszka

unread,
Aug 19, 2026, 1:16:15 PMAug 19
to Sterling Archer, EFI Boot Guard
Thanks for pointing this out!

I agree, things are fairly inconsistent here. "Partition label" is
definitely not right. But I think the correct term is actually "volume
label", see https://www.man7.org/linux/man-pages/man8/fatlabel.8.html,
but also the UEFI spec (). In some places, we already use that.

BTW, your email client unfortunately wrapped things around. Use a
different setting or git send-email if possible. Small patches can be
manually fixed up, but this would not work well for larger ones.

Thanks!
Jan

--
Siemens AG, Foundational Technologies
Linux Expert Center
Reply all
Reply to author
Forward
0 new messages