diff options
author | Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> | 2019-03-08 19:21:54 +0100 |
---|---|---|
committer | Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> | 2019-03-12 09:45:16 +0100 |
commit | 694fe6daf59deef54be8bb210e89d8e694b9b3d7 (patch) | |
tree | 48c93521701e0e9d7b1fe90a1b02d97667bdfd03 | |
parent | cf73f650890b56a59bfb713c4c82b4e29daa7316 (diff) | |
download | systemd-694fe6daf59deef54be8bb210e89d8e694b9b3d7.tar.gz |
man: say $BOOT not /boot in kernel-install(8)
-rw-r--r-- | man/kernel-install.xml | 37 |
1 files changed, 23 insertions, 14 deletions
diff --git a/man/kernel-install.xml b/man/kernel-install.xml index 73b582c848..965c43e465 100644 --- a/man/kernel-install.xml +++ b/man/kernel-install.xml @@ -37,9 +37,9 @@ <refsect1> <title>Description</title> - <para> - <command>kernel-install</command> is used to install and remove kernel and - initramfs images to and from <filename>/boot</filename>. + <para><command>kernel-install</command> is used to install and remove kernel and initramfs images to and + from the boot loader partition, referred to as <varname>$BOOT</varname> here. It will usually be one of + <filename>/boot</filename>, <filename>/efi</filename>, or <filename>/boot/efi</filename>, see below. </para> <para><command>kernel-install</command> will execute the files @@ -71,15 +71,15 @@ <filename>/usr/lib/kernel/install.d/*.install</filename> and <filename>/etc/kernel/install.d/*.install</filename> with the following arguments: - <programlisting>add <replaceable>KERNEL-VERSION</replaceable> <filename>/boot/<replaceable>MACHINE-ID</replaceable>/<replaceable>KERNEL-VERSION</replaceable>/</filename> <replaceable>KERNEL-IMAGE</replaceable> [<replaceable>INITRD-FILE</replaceable> ...]</programlisting> + <programlisting>add <replaceable>KERNEL-VERSION</replaceable> <filename>$BOOT/<replaceable>MACHINE-ID</replaceable>/<replaceable>KERNEL-VERSION</replaceable>/</filename> <replaceable>KERNEL-IMAGE</replaceable> [<replaceable>INITRD-FILE</replaceable> ...]</programlisting> </para> <para>Three default plugins execute the following operations in this case:</para> <itemizedlist> <listitem><para><filename>00-entry-directory.install</filename> creates the directory - <filename>/boot/<replaceable>MACHINE-ID</replaceable>/<replaceable>KERNEL-VERSION</replaceable>/</filename> - if <filename>/boot/<replaceable>MACHINE-ID</replaceable>/</filename> already exists. + <filename>$BOOT/<replaceable>MACHINE-ID</replaceable>/<replaceable>KERNEL-VERSION</replaceable>/</filename> + if <filename>$BOOT/<replaceable>MACHINE-ID</replaceable>/</filename> already exists. </para></listitem> <listitem><para><filename>50-depmod.install</filename> runs @@ -88,19 +88,19 @@ <listitem><para><filename>90-loaderentry.install</filename> copies <replaceable>KERNEL-IMAGE</replaceable> to - <filename>/boot/<replaceable>MACHINE-ID</replaceable>/<replaceable>KERNEL-VERSION</replaceable>/linux</filename>. + <filename>$BOOT/<replaceable>MACHINE-ID</replaceable>/<replaceable>KERNEL-VERSION</replaceable>/linux</filename>. If an <replaceable>INITRD-FILE</replaceable> is provided, it also copies <replaceable>INITRD-FILE</replaceable> to - <filename>/boot/<replaceable>MACHINE-ID</replaceable>/<replaceable>KERNEL_VERSION</replaceable>/<replaceable>INITRD-FILE</replaceable></filename>. + <filename>$BOOT/<replaceable>MACHINE-ID</replaceable>/<replaceable>KERNEL_VERSION</replaceable>/<replaceable>INITRD-FILE</replaceable></filename>. It also creates a boot loader entry according to the <ulink url="https://systemd.io/BOOT_LOADER_SPECIFICATION">Boot Loader Specification</ulink> in - <filename>/boot/loader/entries/<replaceable>MACHINE-ID</replaceable>-<replaceable>KERNEL-VERSION</replaceable>.conf</filename>. + <filename>$BOOT/loader/entries/<replaceable>MACHINE-ID</replaceable>-<replaceable>KERNEL-VERSION</replaceable>.conf</filename>. The title of the entry is the <replaceable>PRETTY_NAME</replaceable> parameter specified in <filename>/etc/os-release</filename> or <filename>/usr/lib/os-release</filename> (if the former is missing), or "Linux <replaceable>KERNEL-VERSION</replaceable>", if unset.</para> <para>If the entry directory - <filename>/boot/<replaceable>MACHINE-ID</replaceable>/<replaceable>KERNEL-VERSION</replaceable>/</filename> + <filename>$BOOT/<replaceable>MACHINE-ID</replaceable>/<replaceable>KERNEL-VERSION</replaceable>/</filename> does not exist, this plugin does nothing.</para></listitem> </itemizedlist> </listitem> @@ -112,11 +112,11 @@ <filename>/usr/lib/kernel/install.d/*.install</filename> and <filename>/etc/kernel/install.d/*.install</filename> with the following arguments: - <programlisting>remove <replaceable>KERNEL-VERSION</replaceable> <filename>/boot/<replaceable>MACHINE-ID</replaceable>/<replaceable>KERNEL-VERSION</replaceable>/</filename></programlisting> + <programlisting>remove <replaceable>KERNEL-VERSION</replaceable> <filename>$BOOT/<replaceable>MACHINE-ID</replaceable>/<replaceable>KERNEL-VERSION</replaceable>/</filename></programlisting> </para> <para>Afterwards, <command>kernel-install</command> removes the directory - <filename>/boot/<replaceable>MACHINE-ID</replaceable>/<replaceable>KERNEL-VERSION</replaceable>/</filename> + <filename>$BOOT/<replaceable>MACHINE-ID</replaceable>/<replaceable>KERNEL-VERSION</replaceable>/</filename> and its contents.</para> <para>Two default plugins execute the following operations in this case:</para> @@ -126,14 +126,23 @@ <listitem><para><filename>50-depmod.install</filename> removes the files generated by <command>depmod</command> for this kernel again.</para></listitem> <listitem><para><filename>90-loaderentry.install</filename> removes the file - <filename>/boot/loader/entries/<replaceable>MACHINE-ID</replaceable>-<replaceable>KERNEL-VERSION</replaceable>.conf</filename>.</para></listitem> + <filename>$BOOT/loader/entries/<replaceable>MACHINE-ID</replaceable>-<replaceable>KERNEL-VERSION</replaceable>.conf</filename>.</para></listitem> </itemizedlist> </listitem> </varlistentry> </variablelist> + </refsect1> + <refsect1> + <title>The <varname>$BOOT</varname> partition</title> + <para>The partition where the kernels and <ulink url="https://systemd.io/BOOT_LOADER_SPECIFICATION">Boot + Loader Specification</ulink> snippets are located is called <varname>$BOOT</varname>. + <command>kernel-install</command> determines the location of this partition by checking + <filename>/efi/</filename>, <filename>/boot/</filename>, and <filename>/boot/efi</filename> + in turn. The first location where <filename>$BOOT/loader/entries/</filename> or + <filename>$BOOT/$MACHINE_ID/</filename> exists is used.</para> </refsect1> <refsect1> @@ -194,7 +203,7 @@ <listitem> <para>Read by <filename>90-loaderentry.install</filename>. If this file exists a numeric value is read from it and the naming of the generated entry file is slightly altered to include it as - <filename>/boot/loader/entries/<replaceable>MACHINE-ID</replaceable>-<replaceable>KERNEL-VERSION</replaceable>+<replaceable>TRIES</replaceable>.conf</filename>. This + <filename>$BOOT/loader/entries/<replaceable>MACHINE-ID</replaceable>-<replaceable>KERNEL-VERSION</replaceable>+<replaceable>TRIES</replaceable>.conf</filename>. This is useful for boot loaders such as <citerefentry><refentrytitle>systemd-boot</refentrytitle><manvolnum>7</manvolnum></citerefentry> which implement boot attempt counting with a counter embedded in the entry file name.</para> |