From: Lennart Poettering <lennart@poettering.net>
Date: Tue, 9 Nov 2021 22:47:45 +0000 (+0100)
Subject: boot: add comments what closely related ConfigEntry fields are about
X-Git-Tag: v250-rc1~300^2~9
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=08cd8c4307a9facc7cc8acbdbe06837869725dd0;p=thirdparty%2Fsystemd.git

boot: add comments what closely related ConfigEntry fields are about
---

diff --git a/src/boot/efi/boot.c b/src/boot/efi/boot.c
index 5992a28cdd0..9dd14bd7b33 100644
--- a/src/boot/efi/boot.c
+++ b/src/boot/efi/boot.c
@@ -44,10 +44,10 @@ enum loader_type {
 };
 
 typedef struct {
-        CHAR16 *id; /* The unique identifier for this entry */
-        CHAR16 *title_show;
-        CHAR16 *title;
-        CHAR16 *version;
+        CHAR16 *id;         /* The unique identifier for this entry (typically the filename of the file defining the entry) */
+        CHAR16 *title_show; /* The string to actually display (this is made unique before showing) */
+        CHAR16 *title;      /* The raw (human readable) title string of the entry (not necessarily unique) */
+        CHAR16 *version;    /* The raw (human readable) version string of the entry */
         CHAR16 *machine_id;
         EFI_HANDLE *device;
         enum loader_type type;