kernel-install: describe usage as installkernel

For us, this is a compatibility mode, but most likely it is there to stay: the
kernel Makefile's install target expects to be able to call /bin/installkernel.
We want people who build their own kernels to use this, so that they use
kernel-install and get support for all the functionality provided by it,
including building of UKIs and other new features. So let's actually advertise
that this exists and works.
This commit is contained in:
Zbigniew Jędrzejewski-Szmek 2023-09-26 21:54:18 +02:00
parent 3d6df0c4e2
commit eb25844f83
2 changed files with 31 additions and 6 deletions

View file

@ -185,10 +185,29 @@
<xi:include href="version-info.xml" xpointer="v251"/>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Compatibility with the kernel build system</title>
<cmdsynopsis>
<command>installkernel</command>
<arg choice="opt" rep="repeat">OPTIONS</arg>
<arg choice="plain">VERSION</arg>
<arg choice="plain">VMLINUZ</arg>
<arg choice="opt">MAP</arg>
<arg choice="opt">INSTALLATION-DIR</arg>
</cmdsynopsis>
<para>When invoked as <command>installkernel</command>, this program accepts arguments as specified by
the kernel build system's <command>make install</command> command. The <parameter>VERSION</parameter> and
<parameter>VMLINUZ</parameter> parameters specify the kernel version and the kernel binary. The other two
parameters (<parameter>MAP</parameter> and <parameter>INSTALLATION-DIR</parameter>) are currently
ignored.
</para>
</refsect1>
<refsect1>
<title>The <varname>$BOOT</varname> partition</title>

View file

@ -1127,10 +1127,11 @@ static int help(void) {
printf("%1$s [OPTIONS...] COMMAND ...\n\n"
"%2$sAdd and remove kernel and initrd images to and from /boot%3$s\n"
"\nUsage:\n"
" %1$s [OPTIONS...] add KERNEL-VERSION KERNEL-IMAGE [INITRD-FILE...]\n"
" %1$s [OPTIONS...] remove KERNEL-VERSION\n"
" %1$s [OPTIONS...] inspect [KERNEL-IMAGE]\n"
"\nOptions:\n"
" kernel-install [OPTIONS...] add KERNEL-VERSION KERNEL-IMAGE [INITRD-FILE...]\n"
" kernel-install [OPTIONS...] remove KERNEL-VERSION\n"
" kernel-install [OPTIONS...] inspect [KERNEL-IMAGE]\n"
"\n"
"Options:\n"
" -h --help Show this help\n"
" --version Show package version\n"
" -v --verbose Increase verbosity\n"
@ -1140,7 +1141,12 @@ static int help(void) {
" Create $BOOT/ENTRY-TOKEN/ directory\n"
" --entry-token=machine-id|os-id|os-image-id|auto|literal:…\n"
" Entry token to use for this installation\n"
"\nSee the %4$s for details.\n",
"\n"
"This program may also be invoked as 'installkernel':\n"
" installkernel [OPTIONS...] VERSION VMLINUZ [MAP] [INSTALLATION-DIR]\n"
"(The optional arguments are passed by kernel build system, but ignored.)\n"
"\n"
"See the %4$s for details.\n",
program_invocation_short_name,
ansi_highlight(),
ansi_normal(),