From: Emil Velikov <emil.velikov@collabora.com>
Date: Mon, 2 Oct 2023 16:56:42 +0000 (+0100)
Subject: man: document LoaderEntryLastBooted
X-Git-Tag: v255-rc1~316^2
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F29438%2Fhead;p=thirdparty%2Fsystemd.git

man: document LoaderEntryLastBooted

The option was introduced with systemd v250 although it went
undocumented. It effectively sits between Default and OneShot, in term
of priority.

It is repeatedly updated as long as loader.conf default is "@saved" and
the OneShot is not set.

v2:
 - squash some typos

v3:
 - special mention to default @saved + loader.conf reference
 - reword update side, to avoid misleading that it's needlessly
   overwritten

Signed-off-by: Emil Velikov <emil.velikov@collabora.com>
---

diff --git a/man/systemd-boot.xml b/man/systemd-boot.xml
index 67208806f97..b6efd8927c9 100644
--- a/man/systemd-boot.xml
+++ b/man/systemd-boot.xml
@@ -461,6 +461,27 @@
         <xi:include href="version-info.xml" xpointer="v240"/></listitem>
       </varlistentry>
 
+      <varlistentry>
+        <term><varname>LoaderEntryLastBooted</varname></term>
+
+        <listitem><para>The identifier of the boot loader entry last attempted. Set and read by the boot loader,
+        only when <filename>/loader/loader.conf</filename> has default set to <literal>@saved</literal>. See
+        <citerefentry><refentrytitle>loader.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
+
+        <para> The boot loader will ensure <varname>LoaderEntryLastBooted</varname> is up-to date for every boot,
+        updating it as needed and will omit changing it all together when <varname>LoaderEntryOneShot</varname>
+        is set.</para>
+
+        <para>The boot loader reads the variable, which takes higher priority than
+        <varname>LoaderEntryDefault</varname>. The variable is ignored when <varname>LoaderEntryOneShot</varname>
+        is set.</para>
+
+        <para><varname>LoaderEntryLastBooted</varname> cannot be used as indication that the last boot was
+        successful or not.</para>
+
+        <xi:include href="version-info.xml" xpointer="v250"/></listitem>
+      </varlistentry>
+
       <varlistentry>
         <term><varname>LoaderEntrySelected</varname></term>