From: Lennart Poettering <lennart@poettering.net>
Date: Mon, 15 Jul 2024 13:48:42 +0000 (+0200)
Subject: man: fix LoaderDevicePathUUID + LoaderImageIdentifier descriptions
X-Git-Tag: v257-rc1~489^2~3
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=8b5ad0ba41dee20cf039d5fd9a4a5af05be43c96;p=thirdparty%2Fsystemd.git

man: fix LoaderDevicePathUUID + LoaderImageIdentifier descriptions

First of all, these were always set, i.e. since sd-boot was merged into
our tree, i.e. v220. Let's say so explicitly.

Also, let's be more accurate, regarding which partition this referes to:
it's usually "the" ESP, but given that you can make firmware boot from
arbitrary disks, it could be any other partition too. Hence, be
explicit on this.

Also, clarify tha sd-stub will set this too, if sd-boot never set it.
---

diff --git a/man/systemd-boot.xml b/man/systemd-boot.xml
index cc4504926c8..0da919b127c 100644
--- a/man/systemd-boot.xml
+++ b/man/systemd-boot.xml
@@ -429,13 +429,15 @@
       <varlistentry>
         <term><varname>LoaderDevicePartUUID</varname></term>
 
-        <listitem><para>Contains the partition UUID of the EFI System Partition the boot loader was run from. Set by
-        the boot
-        loader. <citerefentry><refentrytitle>systemd-gpt-auto-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>
-        uses this information to automatically find the disk booted from, in order to discover various other partitions
-        on the same disk automatically.</para>
+        <listitem><para>Contains the partition UUID of the partition the boot loader has been started from on
+        the current boot (usually a EFI System Partition). Set by the boot loader. (Note that
+        <command>systemd-stub</command> will set this too, if not set yet, to support systems that directly
+        boot into a unified kernel image, bypassing any boot loader.)
+        <citerefentry><refentrytitle>systemd-gpt-auto-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+        uses this information to automatically find the disk booted from, in order to discover various other
+        partitions on the same disk automatically.</para>
 
-        <xi:include href="version-info.xml" xpointer="v240"/></listitem>
+        <xi:include href="version-info.xml" xpointer="v220"/></listitem>
       </varlistentry>
 
       <varlistentry>
@@ -516,12 +518,15 @@
       <varlistentry>
         <term><varname>LoaderImageIdentifier</varname></term>
 
-        <listitem><para>The path of executable of the boot loader used for the current boot, relative to the EFI System
-        Partition's root directory. Set by the boot loader. Use
-        <citerefentry><refentrytitle>bootctl</refentrytitle><manvolnum>1</manvolnum></citerefentry> to view this
-        data.</para>
+        <listitem><para>The file system path to the EFI executable of the boot loader for the current boot,
+        relative to the partition's root directory (i.e. relative to the partition indicated by
+        <varname>LoaderDevicePartUUID</varname>, see above). Set by the boot loader. (Note that
+        <command>systemd-stub</command> will set this too, if not set yet, to support systems that directly
+        boot into a unified kernel image, bypassing any boot loader.) Use
+        <citerefentry><refentrytitle>bootctl</refentrytitle><manvolnum>1</manvolnum></citerefentry> to view
+        this data.</para>
 
-        <xi:include href="version-info.xml" xpointer="v240"/></listitem>
+        <xi:include href="version-info.xml" xpointer="v220"/></listitem>
       </varlistentry>
 
       <varlistentry>