From eab7061898bcd1f2db77bc0a732003bbb2abc67b Mon Sep 17 00:00:00 2001
From: Lennart Poettering <lennart@poettering.net>
Date: Fri, 20 Jan 2023 18:36:31 +0100
Subject: [PATCH] bootctl: split out boot loader spec + boot loader interface
 commands in --help text

grub (at least on fedora) nowadays implements the boot loader spec, but
not the boot loader interface. Hence let's split out the commands
specific to each in two groups in the --help text. This way the first
group just covers boot lodaer spec stuff (i.e. stuff on disk in the
ESP/XBOOTLDR partition). And the other covers talking to the boot loader
via EFI var.
---
 man/bootctl.xml    | 48 +++++++++++++++++++++++++++++-----------------
 src/boot/bootctl.c |  5 +++--
 2 files changed, 33 insertions(+), 20 deletions(-)

diff --git a/man/bootctl.xml b/man/bootctl.xml
index a5a3e6b307..52c9179cd0 100644
--- a/man/bootctl.xml
+++ b/man/bootctl.xml
@@ -85,9 +85,10 @@
   <refsect1>
     <title>Boot Loader Specification Commands</title>
 
-    <para>These commands are available for all boot loaders that implement the <ulink
-    url="https://uapi-group.org/specifications/specs/boot_loader_specification">Boot Loader Specification</ulink> and/or the <ulink
-    url="https://systemd.io/BOOT_LOADER_INTERFACE">Boot Loader Interface</ulink>, such as
+    <para>These commands are available for all boot loaders that
+    implement the <ulink
+    url="https://uapi-group.org/specifications/specs/boot_loader_specification">Boot
+    Loader Specification</ulink>, such as
     <command>systemd-boot</command>.</para>
 
     <variablelist>
@@ -104,6 +105,32 @@
         </listitem>
       </varlistentry>
 
+      <varlistentry>
+        <term><option>unlink</option> <replaceable>ID</replaceable></term>
+
+        <listitem><para>Removes a boot loader entry including the files it refers to. Takes a single boot
+        loader entry ID string or a glob pattern as argument. Referenced files such as kernel or initrd are
+        only removed if no other entry refers to them.</para></listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>cleanup</option></term>
+
+        <listitem><para>Removes files from the ESP and XBOOTLDR partitions that belong to the entry token but
+        are not referenced in any boot loader entries.</para></listitem>
+      </varlistentry>
+    </variablelist>
+  </refsect1>
+
+  <refsect1>
+    <title>Boot Loader Interface Commands</title>
+
+    <para>These commands are available for all boot loaders that implement the <ulink
+    url="https://uapi-group.org/specifications/specs/boot_loader_specification">Boot Loader Specification</ulink> and the <ulink
+    url="https://systemd.io/BOOT_LOADER_INTERFACE">Boot Loader Interface</ulink>, such as
+    <command>systemd-boot</command>.</para>
+
+    <variablelist>
       <varlistentry>
         <term><option>set-default</option> <replaceable>ID</replaceable></term>
         <term><option>set-oneshot</option> <replaceable>ID</replaceable></term>
@@ -153,21 +180,6 @@
         disables the timeout while always showing the menu. When an empty string ("") is specified the
         bootloader will revert to its default menu timeout.</para></listitem>
       </varlistentry>
-
-      <varlistentry>
-        <term><option>unlink</option> <replaceable>ID</replaceable></term>
-
-        <listitem><para>Removes a boot loader entry including the files it refers to. Takes a single boot
-        loader entry ID string or a glob pattern as argument. Referenced files such as kernel or initrd are
-        only removed if no other entry refers to them.</para></listitem>
-      </varlistentry>
-
-      <varlistentry>
-        <term><option>cleanup</option></term>
-
-        <listitem><para>Removes files from the ESP and XBOOTLDR partitions that belong to the entry token but
-        are not referenced in any boot loader entries.</para></listitem>
-      </varlistentry>
     </variablelist>
   </refsect1>
 
diff --git a/src/boot/bootctl.c b/src/boot/bootctl.c
index 5ce5cb042e..ee8d5c6e61 100644
--- a/src/boot/bootctl.c
+++ b/src/boot/bootctl.c
@@ -141,13 +141,14 @@ static int help(int argc, char *argv[], void *userdata) {
                "                       Query or set system options string in EFI variable\n"
                "\n%3$sBoot Loader Specification Commands:%4$s\n"
                "  list                 List boot loader entries\n"
+               "  unlink ID            Remove boot loader entry\n"
+               "  cleanup              Remove files in ESP not referenced in any boot entry\n"
+               "\n%3$sBoot Loader Interface Commands:%4$s\n"
                "  set-default ID       Set default boot loader entry\n"
                "  set-oneshot ID       Set default boot loader entry, for next boot only\n"
                "  set-timeout SECONDS  Set the menu timeout\n"
                "  set-timeout-oneshot SECONDS\n"
                "                       Set the menu timeout for the next boot only\n"
-               "  unlink ID            Remove boot loader entry\n"
-               "  cleanup              Remove files in ESP not referenced in any boot entry\n"
                "\n%3$ssystemd-boot Commands:%4$s\n"
                "  install              Install systemd-boot to the ESP and EFI variables\n"
                "  update               Update systemd-boot in the ESP and EFI variables\n"