]> git.ipfire.org Git - thirdparty/systemd.git/commitdiff
man/kernel-install: add more paragraph breaks, fix indentation
authorZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Thu, 7 Sep 2023 10:29:38 +0000 (12:29 +0200)
committerZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Fri, 15 Sep 2023 07:00:23 +0000 (09:00 +0200)
man/kernel-install.xml

index 797e78f29177a24cebeba56e18599f61a4433660..9a21fd65e81b2e602578125402249e90883c72e6 100644 (file)
     <para>The following commands are understood:</para>
     <variablelist>
       <varlistentry>
-        <term><command>add <replaceable>KERNEL-VERSION</replaceable> <replaceable>KERNEL-IMAGE</replaceable> [<replaceable>INITRD-FILE</replaceable> ...]</command></term>
+        <term>
+          <command>add</command>
+          <replaceable>KERNEL-VERSION</replaceable>
+          <replaceable>KERNEL-IMAGE</replaceable> [<replaceable>INITRD-FILE</replaceable> ...]
+        </term>
+
         <listitem>
           <para>This command expects a kernel version string and a path to a kernel image file as arguments.
           Optionally, one or more initrd images may be specified as well (note that plugins might generate
-          additional ones). <command>kernel-install</command> calls the executable files from
-          <filename>/usr/lib/kernel/install.d/*.install</filename> and
-          <filename>/etc/kernel/install.d/*.install</filename> (i.e. the plugins) with the following
-          arguments:</para>
+          additional ones).</para>
+
+          <para>The executable files from <filename>/usr/lib/kernel/install.d/*.install</filename> and
+          <filename>/etc/kernel/install.d/*.install</filename> (i.e. the plugins) are called with the
+          following arguments:</para>
 
-          <programlisting>add <replaceable>KERNEL-VERSION</replaceable> <filename>$BOOT/<replaceable>ENTRY-TOKEN</replaceable>/<replaceable>KERNEL-VERSION</replaceable>/</filename> <replaceable>KERNEL-IMAGE</replaceable> [<replaceable>INITRD-FILE</replaceable> ...]</programlisting>
+          <programlisting>add <replaceable>KERNEL-VERSION</replaceable> <filename>$BOOT/<replaceable>ENTRY-TOKEN</replaceable>/<replaceable>KERNEL-VERSION</replaceable>/</filename> <replaceable>KERNEL-IMAGE</replaceable> \
+          [<replaceable>INITRD-FILE</replaceable> ...]</programlisting>
 
           <para>The third argument directly refers to the path where to place kernel images, initrd
-          images and other resources for <ulink url="https://uapi-group.org/specifications/specs/boot_loader_specification">Boot
+          images and other resources for
+          <ulink url="https://uapi-group.org/specifications/specs/boot_loader_specification">Boot
           Loader Specification</ulink> Type #1 entries (the "entry directory"). If other boot loader schemes
-          are used the parameter may be ignored. The <replaceable>ENTRY-TOKEN</replaceable> string is
-          typically the machine ID and is supposed to identify the local installation on the system. For
-          details see below.</para>
+          are used the parameter may be ignored.</para>
+
+          <para>The <replaceable>ENTRY-TOKEN</replaceable> string is typically the machine ID and is supposed
+          to identify the local installation on the system. For details see below.</para>
 
           <para>Two default plugins execute the following operations in this case:</para>
 
       <varlistentry>
         <term><command>remove <replaceable>KERNEL-VERSION</replaceable></command></term>
         <listitem>
-          <para>This command expects a kernel version string as single argument. This calls executables from
-          <filename>/usr/lib/kernel/install.d/*.install</filename> and
-          <filename>/etc/kernel/install.d/*.install</filename> with the following arguments:
-          </para>
+          <para>This command expects a kernel version string as single argument.</para>
+
+          <para>The executable files from <filename>/usr/lib/kernel/install.d/*.install</filename> and
+          <filename>/etc/kernel/install.d/*.install</filename> (i.e. the plugins) are called with the
+          following arguments:</para>
 
           <programlisting>remove <replaceable>KERNEL-VERSION</replaceable> <filename>$BOOT/<replaceable>ENTRY-TOKEN</replaceable>/<replaceable>KERNEL-VERSION</replaceable>/</filename></programlisting>
 
           <para>Two default plugins execute the following operations in this case:</para>
 
           <itemizedlist>
-            <listitem><para><filename>50-depmod.install</filename> removes the files generated by <command>depmod</command> for this kernel again.</para></listitem>
+            <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>ENTRY-TOKEN</replaceable>-<replaceable>KERNEL-VERSION</replaceable>.conf</filename>.</para></listitem>
+            <filename>$BOOT/loader/entries/<replaceable>ENTRY-TOKEN</replaceable>-<replaceable>KERNEL-VERSION</replaceable>.conf</filename>.
+            </para></listitem>
 
             <listitem><para><filename>90-uki-copy.install</filename> removes the file
-            <filename>$BOOT/EFI/Linux/<replaceable>ENTRY-TOKEN</replaceable>-<replaceable>KERNEL-VERSION</replaceable>.efi</filename>.</para></listitem>
+            <filename>$BOOT/EFI/Linux/<replaceable>ENTRY-TOKEN</replaceable>-<replaceable>KERNEL-VERSION</replaceable>.efi</filename>.
+            </para></listitem>
           </itemizedlist>
 
             <xi:include href="version-info.xml" xpointer="v203"/>
           <filename>/etc/kernel/uki.conf</filename>
         </term>
           <listitem>
-            <para>Ini-style configuration file for <citerefentry><refentrytitle>ukify</refentrytitle><manvolnum>1</manvolnum></citerefentry> which is only effective when <varname>$KERNEL_INSTALL_LAYOUT</varname> or <varname>layout=</varname> in <filename>install.conf</filename> is set to <option>uki</option> and <varname>$KERNEL_INSTALL_UKI_GENERATOR</varname> or <varname>uki_generator=</varname> in <filename>install.conf</filename> is set to <option>ukify</option>.
+            <para>Ini-style configuration file for
+            <citerefentry><refentrytitle>ukify</refentrytitle><manvolnum>1</manvolnum></citerefentry> which
+            is only effective when <varname>$KERNEL_INSTALL_LAYOUT</varname> or <varname>layout=</varname> in
+            <filename>install.conf</filename> is set to <option>uki</option> and
+            <varname>$KERNEL_INSTALL_UKI_GENERATOR</varname> or <varname>uki_generator=</varname> in
+            <filename>install.conf</filename> is set to <option>ukify</option>.
             <varname>$KERNEL_INSTALL_CONF_ROOT</varname> may be used to override the path.
             </para>
 
-          <xi:include href="version-info.xml" xpointer="v255"/>
+            <xi:include href="version-info.xml" xpointer="v255"/>
           </listitem>
       </varlistentry>
     </variablelist>