From: Zbigniew Jędrzejewski-Szmek Date: Wed, 11 Oct 2023 15:34:43 +0000 (+0200) Subject: man/kernel-install: fix formatting and document /etc/kernel/devicetree X-Git-Tag: v255-rc1~264^2~3 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=7a9d86bceb4fa99c2eb86b2d06e71346f1001953;p=thirdparty%2Fsystemd.git man/kernel-install: fix formatting and document /etc/kernel/devicetree Each filename should be a separate , so that they separated in the formatted text. Also, we list files in documentation in priority order, but here they were in reverse order. Also, rework the description of $KERNEL_INSTALL_CONF_ROOT to say that it makes kernel-install not look at the other files. This requires some more words, so make this a separate paragraph and refer from individual items to it. Also, drop some sentences with "Read by ...", they were already outdated. Partial fix for #28771. Co-authored-by: Emil Renner Berthing --- diff --git a/man/kernel-install.xml b/man/kernel-install.xml index ddcc2184ac4..889520ff6e0 100644 --- a/man/kernel-install.xml +++ b/man/kernel-install.xml @@ -471,64 +471,81 @@ Files - - /usr/lib/kernel/install.d/*.install - /etc/kernel/install.d/*.install - - - Drop-in files which are executed by kernel-install. + /etc/kernel/install.d/*.install + /usr/lib/kernel/install.d/*.install + + Drop-in files which are executed by kernel-install. - + + - - /usr/lib/kernel/cmdline - /etc/kernel/cmdline - /proc/cmdline - - - Read by 90-loaderentry.install. The content of the file - /etc/kernel/cmdline specifies the kernel command line to use. If that file - does not exist, /usr/lib/kernel/cmdline is used. If that also does not - exist, /proc/cmdline is used. $KERNEL_INSTALL_CONF_ROOT - may be used to override the path. + /etc/kernel/cmdline + /usr/lib/kernel/cmdline + /proc/cmdline + + Specifies the kernel command line to use. The first of the files that is found will be used. + $KERNEL_INSTALL_CONF_ROOT may be used to override the search path; see below for + details. - + + + + + /etc/kernel/devicetree + /usr/lib/kernel/devicetree + + Specifies the partial path to the file containing the device tree blob to install with the + kernel and use at boot. The first of the files that is found will be used. + $KERNEL_INSTALL_CONF_ROOT may be used to override the search path; see below for + details. + + The devicetree file contains a path, and this path specifies a location + relative to the kernel install tree. A set of locations is checked, including in particular + /usr/lib/modules/KERNEL_VERSION/dtb/, which is the + recommended location to place the dtb files under. For example, with + broadcom/bcm2711-rpi-4-b.dtb in the devicetree file, the + device tree blob for the Raspberry Pi 4 Model B would be installed, and the actual file would be + /usr/lib/modules/KERNEL_VERSION/dtb/broadcom/bcm2711-rpi-4-b.dtb. + + + + + - - /etc/kernel/tries - - - Read by 90-loaderentry.install and - 90-uki-copy.install. If this file exists a numeric value is read from it - and the naming of the generated entry file or UKI is slightly altered to include it as - $BOOT/loader/entries/ENTRY-TOKEN-KERNEL-VERSION+TRIES.conf - or - $BOOT/EFI/Linux/ENTRY-TOKEN-KERNEL-VERSION+TRIES.efi, respectively. This - is useful for boot loaders such as - systemd-boot7 - which implement boot attempt counting with a counter embedded in the entry file name. - $KERNEL_INSTALL_CONF_ROOT may be used to override the path. + /etc/kernel/tries + + Read by 90-loaderentry.install and + 90-uki-copy.install. If this file exists, a numeric value is read from it and + the naming of the generated entry file or UKI is altered to include it as + $BOOT/loader/entries/ENTRY-TOKEN-KERNEL-VERSION+TRIES.conf + or + $BOOT/EFI/Linux/ENTRY-TOKEN-KERNEL-VERSION+TRIES.efi, + respectively. This is useful for boot loaders such as + systemd-boot7 + which implement boot attempt counting with a counter embedded in the entry file name. + $KERNEL_INSTALL_CONF_ROOT may be used to override the search path; see below for + details. - + + - - /etc/kernel/entry-token - - - If this file exists it is read and used as "entry token" for this system, i.e. is used for - naming Boot Loader Specification entries, see $KERNEL_INSTALL_ENTRY_TOKEN - above for details. $KERNEL_INSTALL_CONF_ROOT may be used to override the - path. + /etc/kernel/entry-token + + If this file exists it is read and used as "entry token" for this system, i.e. is used for + naming Boot Loader Specification entries. See $KERNEL_INSTALL_ENTRY_TOKEN above + for details. $KERNEL_INSTALL_CONF_ROOT may be used to override the search path; see + below for details. - - + + + /etc/machine-id @@ -540,63 +557,62 @@ + - - /etc/os-release - /usr/lib/os-release - + /etc/os-release + /usr/lib/os-release - Read by 90-loaderentry.install. - If available, PRETTY_NAME= is read from these files and used as the title of the boot menu entry. - Otherwise, Linux KERNEL-VERSION will be used. + Read by 90-loaderentry.install. If available, + PRETTY_NAME= is read from these files and used as the title of the boot menu + entry. Otherwise, Linux KERNEL-VERSION will be + used. - + - - /usr/lib/kernel/install.conf - /etc/kernel/install.conf - - - Configuration options for kernel-install, as a series of - KEY=VALUE assignments, compatible with shell - syntax, following the same rules as described in - os-release5. - /etc/kernel/install.conf will be read if present, and - /usr/lib/kernel/install.conf otherwise. This file is optional. - $KERNEL_INSTALL_CONF_ROOT may be used to override the path. - - - Currently, the following keys are supported: - MACHINE_ID=, - BOOT_ROOT=, - layout=, - initrd_generator=, - uki_generator=. - See the Environment variables section above for details. + /etc/kernel/install.conf + /usr/lib/kernel/install.conf + + Configuration file with options for kernel-install, as a series of + KEY=VALUE assignments, compatible with shell syntax, + following the same rules as described in + os-release5. The + first of the files that is found will be used. $KERNEL_INSTALL_CONF_ROOT may be + used to override the search path; see below for details. + + Currently, the following keys are supported: + MACHINE_ID=, + BOOT_ROOT=, + layout=, + initrd_generator=, + uki_generator=. + See the Environment variables section above for details. - - + + - - /etc/kernel/uki.conf - - - Ini-style configuration file for - ukify1 which - is only effective when $KERNEL_INSTALL_LAYOUT or layout= in - install.conf is set to and - $KERNEL_INSTALL_UKI_GENERATOR or uki_generator= in - install.conf is set to . - $KERNEL_INSTALL_CONF_ROOT may be used to override the path. - - - - + /etc/kernel/uki.conf + + Ini-style configuration file for + ukify1 which is + only effective when $KERNEL_INSTALL_LAYOUT or layout= in + install.conf is set to and + $KERNEL_INSTALL_UKI_GENERATOR or uki_generator= in + install.conf is set to . + $KERNEL_INSTALL_CONF_ROOT may be used to override the search path; see below for + details. + + + + + For various cases listed above, if the $KERNEL_INSTALL_CONF_ROOT environment + variable is set, it will override the search path. The files will be loaded only + from the directory specified by the environment variable. When the variable is not set, the listed paths + are tried in turn, and the first file that exists is used.