From: Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Date: Mon, 28 Jul 2025 12:38:39 +0000 (+0200)
Subject: man: fix confusion in loader.conf
X-Git-Tag: v258-rc2~50^2~4
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=a83de23353aa9e41d59cf198f1c8fd5d56c1e97b;p=thirdparty%2Fsystemd.git

man: fix confusion in loader.conf

For some reason, the man page for loader.conf also mentioned type#1 entries
in passing. Except for using the same file extension, those files are in a
completely different format and with a different purpose. This mixup was
first introduced in f37d3835828c45b3a92ed12d9a6a30796c0a4a27, was then
reported in #10923, which was closed by cbae79b8d07327051c1e1f438f7086ab634b93f8,
but that didn't fix the actual issue.

Really fixes #10923.

While at it, simplify and improve the wording a bit.
---

diff --git a/man/loader.conf.xml b/man/loader.conf.xml
index f14b77b5371..293f59adfdb 100644
--- a/man/loader.conf.xml
+++ b/man/loader.conf.xml
@@ -21,47 +21,44 @@
   </refnamediv>
 
   <refsynopsisdiv>
-    <para><filename><replaceable>ESP</replaceable>/loader/loader.conf</filename>,
-    <filename><replaceable>ESP</replaceable>/loader/entries/*.conf</filename>
-    <filename><replaceable>XBOOTLDR</replaceable>/loader/entries/*.conf</filename>
-    </para>
+    <para><filename><replaceable>ESP</replaceable>/loader/loader.conf</filename></para>
   </refsynopsisdiv>
 
   <refsect1>
     <title>Description</title>
 
     <para>
-    <citerefentry><refentrytitle>systemd-boot</refentrytitle><manvolnum>7</manvolnum></citerefentry> will
-    read <filename><replaceable>ESP</replaceable>/loader/loader.conf</filename>, and any files with the
-    <literal>.conf</literal> extension under
-    <filename><replaceable>ESP</replaceable>/loader/entries/</filename> on the EFI system partition (ESP),
-    and <filename><replaceable>XBOOTLDR</replaceable>/loader/entries/</filename> on the extended boot loader
-    partition (XBOOTLDR) as defined by <ulink url="https://uapi-group.org/specifications/specs/boot_loader_specification">Boot Loader
-    Specification</ulink>.
+    <citerefentry><refentrytitle>systemd-boot</refentrytitle><manvolnum>7</manvolnum></citerefentry> reads
+    <filename><replaceable>ESP</replaceable>/loader/loader.conf</filename>. This file configures whether the
+    menu is shown and for how long, the font, audible beep, types of menu entries to show, the default
+    choice, and some aspects of Secure Boot enrollment and firmware handling. See the list of available
+    options below.</para>
+
+    <para>The file uses UTF-8 encoding and consists of series of lines separated by "line feed" (i.e. ASCII
+    code 10). Lines that are empty or start with the comment sign (<literal>#</literal>) are ignored. Other
+    lines consist of an option name, followed by whitespace, and the option value.
     </para>
 
-    <para>Each of these configuration files must consist of series of newline (i.e. ASCII code 10) separated
-    lines, each consisting of an option name, followed by whitespace, and the option
-    value. <literal>#</literal> may be used to start a comment line. Empty and comment lines are ignored. The
-    files use UTF-8 encoding.</para>
-
     <para>Boolean arguments may be written as
-    <literal>yes</literal>/<literal>y</literal>/<literal>true</literal>/<literal>t</literal>/<literal>on</literal>/<literal>1</literal> or
+    <literal>yes</literal>/<literal>y</literal>/<literal>true</literal>/<literal>t</literal>/<literal>on</literal>/<literal>1</literal>
+    or
     <literal>no</literal>/<literal>n</literal>/<literal>false</literal>/<literal>f</literal>/<literal>off</literal>/<literal>0</literal>.
     </para>
+
+    <para>Note: <command>systemd-boot</command> will also read boot loader entry files,
+    type #1 (<filename><replaceable>ESP</replaceable>/loader/entries/*.conf</filename> and
+    <filename><replaceable>XBOOTLDR</replaceable>/loader/entries/*.conf</filename>)
+    and type #2 (<filename><replaceable>ESP</replaceable>/EFI/Linux/*.uki</filename>
+    and <filename><replaceable>XBOOTLDR</replaceable>/EFI/Linux/*.uki</filename>).
+    Those files are described by the
+    <ulink url="https://uapi-group.org/specifications/specs/boot_loader_specification">Boot Loader
+    Specification</ulink>.</para>
   </refsect1>
 
   <refsect1>
     <title>Options</title>
 
-    <para>The configuration options supported by
-    <filename><replaceable>ESP</replaceable>/loader/entries/*.conf</filename> and
-    <filename><replaceable>XBOOTLDR</replaceable>/loader/entries/*.conf</filename> files are defined as part
-    of the <ulink url="https://uapi-group.org/specifications/specs/boot_loader_specification">Boot Loader
-    Specification</ulink>.</para>
-
-    <para>The following configuration are supported by the <filename>loader.conf</filename> configuration
-    file:</para>
+    <para>The following configuration are supported in <filename>loader.conf</filename>:</para>
 
     <variablelist>
       <varlistentry>