From 84df0f315a37702de483bf76f74e28796b5035c0 Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Tue, 22 Mar 2022 00:13:10 +0100 Subject: [PATCH 1/4] man: clarify the format used by sd-boot config files --- man/loader.conf.xml | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/man/loader.conf.xml b/man/loader.conf.xml index 1186d3e2b48..bfa4e2da90a 100644 --- a/man/loader.conf.xml +++ b/man/loader.conf.xml @@ -37,9 +37,10 @@ defined by Boot Loader Specification. - Each configuration file must consist of an option name, followed by - whitespace, and the option value. # may be used to start - a comment line. Empty and comment lines are ignored. + 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. # may be used to start a comment line. Empty and comment lines are ignored. The + files use UTF-8 encoding. Boolean arguments may be written as yes/y/true/t/on/1 or From d212b862bf53939baae982126ab1b204964042dd Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Tue, 22 Mar 2022 00:14:22 +0100 Subject: [PATCH 2/4] man: clarify where the settings in type #1 entries are documented So (maybe weirdly) loader.conf(5) documents both loader.conf and type #1 entries (because they share a similar syntax). But it then only lists the options of loader.conf. Let's add an explicit hint where to find the documentation of the type #1 entries. --- man/loader.conf.xml | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/man/loader.conf.xml b/man/loader.conf.xml index bfa4e2da90a..b68601cb09e 100644 --- a/man/loader.conf.xml +++ b/man/loader.conf.xml @@ -51,7 +51,12 @@ Options - The following configuration options in loader.conf are understood: + The configuration options supported by + ESP/loader/entries/*.conf files are defined as part of + the Boot Loader Specification. + + The following configuration are supported by the loader.conf configuration + file: From 838f094ce747a07e653a489d080b23c7cad2e02b Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Tue, 22 Mar 2022 00:19:32 +0100 Subject: [PATCH 3/4] man: also install systemd-stub man page as sd-stub So, typically systemd-boot is referenced as sd-boot, due to te usual shorter naming in ESP resources. systemd-stub didnt do that so far, since it never appears as separate files in the ESP. However it's super annoying that you can find "man sd-boot", but not the very closely related "man sd-stub". Let's fix that, and also add an "sd-stub" alias to the "systemd-stub" man page. --- man/rules/meson.build | 2 +- man/systemd-stub.xml | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/man/rules/meson.build b/man/rules/meson.build index aa969344abe..aaa69d30385 100644 --- a/man/rules/meson.build +++ b/man/rules/meson.build @@ -971,7 +971,7 @@ manpages = [ ['systemd-stdio-bridge', '1', [], ''], ['systemd-stub', '7', - ['linuxaa64.efi.stub', 'linuxia32.efi.stub', 'linuxx64.efi.stub'], + ['linuxaa64.efi.stub', 'linuxia32.efi.stub', 'linuxx64.efi.stub', 'sd-stub'], 'HAVE_GNU_EFI'], ['systemd-suspend.service', '8', diff --git a/man/systemd-stub.xml b/man/systemd-stub.xml index 28c6ba938cb..f2d3b91e20f 100644 --- a/man/systemd-stub.xml +++ b/man/systemd-stub.xml @@ -17,6 +17,7 @@ systemd-stub + sd-stub linuxx64.efi.stub linuxia32.efi.stub linuxaa64.efi.stub From cafa9d87b48c4221e21b2c5236eb44cc6fcf3941 Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Tue, 22 Mar 2022 00:21:36 +0100 Subject: [PATCH 4/4] man: clarify that type #1 entries are also read from the XBOOTLDR partition --- man/loader.conf.xml | 13 +++++++++---- man/systemd-boot.xml | 12 ++++++------ 2 files changed, 15 insertions(+), 10 deletions(-) diff --git a/man/loader.conf.xml b/man/loader.conf.xml index b68601cb09e..d5abb1c04ec 100644 --- a/man/loader.conf.xml +++ b/man/loader.conf.xml @@ -23,6 +23,7 @@ ESP/loader/loader.conf, ESP/loader/entries/*.conf + XBOOTLDR/loader/entries/*.conf @@ -33,8 +34,10 @@ systemd-boot7 will read ESP/loader/loader.conf, and any files with the .conf extension under - ESP/loader/entries/ on the EFI system partition (ESP) as - defined by Boot Loader Specification. + ESP/loader/entries/ on the EFI system partition (ESP), + and XBOOTLDR/loader/entries/ on the extended boot loader + partition (XBOOTLDR) as defined by Boot Loader + Specification. Each of these configuration files must consist of series of newline (i.e. ASCII code 10) separated @@ -52,8 +55,10 @@ Options The configuration options supported by - ESP/loader/entries/*.conf files are defined as part of - the Boot Loader Specification. + ESP/loader/entries/*.conf and + XBOOTLDR/loader/entries/*.conf files are defined as part + of the Boot Loader + Specification. The following configuration are supported by the loader.conf configuration file: diff --git a/man/systemd-boot.xml b/man/systemd-boot.xml index 6029330dd10..393c0312fa3 100644 --- a/man/systemd-boot.xml +++ b/man/systemd-boot.xml @@ -30,12 +30,12 @@ systemd-boot loads boot entry information from the EFI system partition (ESP), usually mounted at /efi/, /boot/, or - /boot/efi/ during OS runtime, as well as from the Extended Boot Loader partition if - it exists (usually mounted to /boot/). Configuration file fragments, kernels, - initrds and other EFI images to boot generally need to reside on the ESP or the Extended Boot Loader - partition. Linux kernels must be built with to be able to be directly - executed as an EFI image. During boot systemd-boot automatically assembles a list of - boot entries from the following sources: + /boot/efi/ during OS runtime, as well as from the Extended Boot Loader partition + (XBOOTLDR) if it exists (usually mounted to /boot/). Configuration file fragments, + kernels, initrds and other EFI images to boot generally need to reside on the ESP or the Extended Boot + Loader partition. Linux kernels must be built with to be able to be + directly executed as an EFI image. During boot systemd-boot automatically assembles a + list of boot entries from the following sources: Boot entries defined with