All of lore.kernel.org
 help / color / mirror / Atom feed
From: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
To: Masahiro Yamada <masahiroy@kernel.org>,
	Michal Marek <michal.lkml@markovi.net>
Cc: linux-kbuild@vger.kernel.org, linux-arch@vger.kernel.org,
	linux-kernel@vger.kernel.org,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Subject: [PATCH 20/20] kbuild: scripts/install.sh: update documentation
Date: Wed,  7 Apr 2021 07:34:19 +0200	[thread overview]
Message-ID: <20210407053419.449796-21-gregkh@linuxfoundation.org> (raw)
In-Reply-To: <20210407053419.449796-1-gregkh@linuxfoundation.org>

Add a proper SPDX line and document the install.sh file a lot better,
explaining exactly what it does, and update the copyright notice and
provide a better message about the lack of LILO being present or not as
really, no one should be using that anymore...

Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
---
 scripts/install.sh | 33 ++++++++++++++++++++++++++-------
 1 file changed, 26 insertions(+), 7 deletions(-)

diff --git a/scripts/install.sh b/scripts/install.sh
index 225b19bbbfa6..dd86fb9971e9 100644
--- a/scripts/install.sh
+++ b/scripts/install.sh
@@ -1,14 +1,14 @@
 #!/bin/sh
-#
-# This file is subject to the terms and conditions of the GNU General Public
-# License.  See the file "COPYING" in the main directory of this archive
-# for more details.
+# SPDX-License-Identifier: GPL-2.0
 #
 # Copyright (C) 1995 by Linus Torvalds
+# Copyright (C) 2021 Greg Kroah-Hartman
 #
 # Adapted from code in arch/i386/boot/Makefile by H. Peter Anvin
+# Adapted from code in arch/i386/boot/install.sh by Russell King
+# Adapted from code in arch/arm/boot/install.sh by Stuart Menefy
 #
-# "make install" script for i386 architecture
+# "make install" script for Linux to be used by all architectures.
 #
 # Arguments:
 #   $1 - kernel version
@@ -16,6 +16,26 @@
 #   $3 - kernel map file
 #   $4 - default install path (blank if root directory)
 #
+# Installs the built kernel image and map and symbol file in the specified
+# install location.  If no install path is selected, the files will be placed
+# in the root directory.
+#
+# The name of the kernel image will be "vmlinux-VERSION" for uncompressed
+# kernels or "vmlinuz-VERSION' for compressed kernels.
+#
+# The kernel map file will be named "System.map-VERSION"
+#
+# Note, not all architectures seem to like putting the VERSION number in the
+# file name, see below in the script for a list of those that do not.  For
+# those that do not the "-VERSION" will not be present in the file name.
+#
+# If there is currently a kernel image or kernel map file present with the name
+# of the file to be copied to the location, it will be renamed to contain a
+# ".old" suffix.
+#
+# If ~/bin/${INSTALLKERNEL} or /sbin/${INSTALLKERNEL} is executable, execution
+# will be passed to that program instead of this one to allow for distro or
+# system specific installation scripts to be used.
 
 verify () {
 	if [ ! -f "$1" ]; then
@@ -45,7 +65,6 @@ verify "$2"
 verify "$3"
 
 # User may have a custom install script
-
 if [ -x ~/bin/"${INSTALLKERNEL}" ]; then exec ~/bin/"${INSTALLKERNEL}" "$@"; fi
 if [ -x /sbin/"${INSTALLKERNEL}" ]; then exec /sbin/"${INSTALLKERNEL}" "$@"; fi
 
@@ -111,7 +130,7 @@ case "${ARCH}" in
 		elif [ -x /etc/lilo/install ]; then
 			/etc/lilo/install
 		else
-			echo "Cannot find LILO."
+			echo "Cannot find LILO, ensure your bootloader knows of the new kernel image."
 		fi
 		;;
 esac
-- 
2.31.1


  parent reply	other threads:[~2021-04-07  5:35 UTC|newest]

Thread overview: 70+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-04-07  5:33 [PATCH 00/20] kbuild: unify the install.sh script usage Greg Kroah-Hartman
2021-04-07  5:34 ` [PATCH 01/20] kbuild: move x86 install script to scripts/install.sh Greg Kroah-Hartman
2021-04-09  3:08   ` Kees Cook
2021-04-07  5:34 ` [PATCH 02/20] kbuild: scripts/install.sh: properly quote all variables Greg Kroah-Hartman
2021-04-07 10:59   ` Masahiro Yamada
2021-04-07  5:34 ` [PATCH 03/20] kbuild: scripts/install.sh: provide a "install" function Greg Kroah-Hartman
2021-04-07 11:01   ` Masahiro Yamada
2021-04-07  5:34 ` [PATCH 04/20] kbuild: scripts/install.sh: call sync before calling the bootloader installer Greg Kroah-Hartman
2021-04-07 11:03   ` Masahiro Yamada
2021-04-07  5:34 ` [PATCH 05/20] kbuild: scripts/install.sh: prepare for arch-specific bootloaders Greg Kroah-Hartman
2021-04-09  3:08   ` Kees Cook
2021-04-07  5:34 ` [PATCH 06/20] kbuild: scripts/install.sh: handle compressed/uncompressed kernel images Greg Kroah-Hartman
2021-04-07 11:04   ` Masahiro Yamada
2021-04-07  5:34 ` [PATCH 07/20] kbuild: scripts/install.sh: allow for the version number Greg Kroah-Hartman
2021-04-07 11:05   ` Masahiro Yamada
2021-04-07 13:03     ` Greg Kroah-Hartman
2021-04-07 13:21       ` Masahiro Yamada
2021-04-07  5:34 ` [PATCH 08/20] kbuild: riscv: use common install script Greg Kroah-Hartman
2021-04-07  5:34   ` Greg Kroah-Hartman
2021-04-09  3:09   ` Kees Cook
2021-04-09  3:09     ` Kees Cook
2021-04-07  5:34 ` [PATCH 09/20] kbuild: arm64: " Greg Kroah-Hartman
2021-04-07  5:34   ` Greg Kroah-Hartman
2021-04-07 14:30   ` Catalin Marinas
2021-04-07 14:30     ` Catalin Marinas
2021-04-09  3:08   ` Kees Cook
2021-04-09  3:08     ` Kees Cook
2021-04-09  6:37     ` Greg Kroah-Hartman
2021-04-09  6:37       ` Greg Kroah-Hartman
2021-04-07  5:34 ` [PATCH 10/20] kbuild: arm: " Greg Kroah-Hartman
2021-04-07  5:34   ` Greg Kroah-Hartman
2021-04-09  3:09   ` Kees Cook
2021-04-09  3:09     ` Kees Cook
2021-04-07  5:34 ` [PATCH 11/20] kbuild: ia64: " Greg Kroah-Hartman
2021-04-07 18:02   ` Sergei Trofimovich
2021-04-09  3:10   ` Kees Cook
2021-04-07  5:34 ` [PATCH 12/20] kbuild: m68k: " Greg Kroah-Hartman
2021-04-07  7:19   ` Geert Uytterhoeven
2021-04-09  3:10   ` Kees Cook
2021-04-07  5:34 ` [PATCH 13/20] kbuild: nds32: convert to use the common install scripts Greg Kroah-Hartman
2021-04-07 11:20   ` Masahiro Yamada
2021-04-07  5:34 ` [PATCH 14/20] kbuild: nios2: use common install script Greg Kroah-Hartman
2021-04-09  3:09   ` Kees Cook
2021-04-07  5:34 ` [PATCH 15/20] kbuild: parisc: " Greg Kroah-Hartman
2021-04-07 11:23   ` Masahiro Yamada
2021-04-14 16:30     ` Helge Deller
2021-04-14 17:51       ` Greg Kroah-Hartman
2021-04-07  5:34 ` [PATCH 16/20] kbuild: powerpc: " Greg Kroah-Hartman
2021-04-07  5:34   ` Greg Kroah-Hartman
2021-04-07 11:32   ` Masahiro Yamada
2021-04-07 11:32     ` Masahiro Yamada
2021-04-07  5:34 ` [PATCH 17/20] kbuild: s390: " Greg Kroah-Hartman
2021-04-07 12:15   ` Heiko Carstens
2021-04-09  3:10   ` Kees Cook
2021-04-07  5:34 ` [PATCH 18/20] kbuild: sh: remove unused " Greg Kroah-Hartman
2021-04-09  3:09   ` Kees Cook
2021-08-24 15:22   ` Masahiro Yamada
2021-08-27 14:02     ` Greg Kroah-Hartman
2021-04-07  5:34 ` [PATCH 19/20] kbuild: sparc: use common " Greg Kroah-Hartman
2021-04-09  3:09   ` Kees Cook
2021-04-07  5:34 ` Greg Kroah-Hartman [this message]
2021-04-07 11:45   ` [PATCH 20/20] kbuild: scripts/install.sh: update documentation Masahiro Yamada
2021-04-07  7:18 ` [PATCH 00/20] kbuild: unify the install.sh script usage Geert Uytterhoeven
2021-04-07  7:46   ` Greg Kroah-Hartman
2021-04-07  8:02     ` Russell King - ARM Linux admin
2021-04-07  8:07       ` Greg Kroah-Hartman
2021-04-07  8:14         ` Russell King - ARM Linux admin
2021-04-07  8:37           ` Greg Kroah-Hartman
2021-04-07 10:53             ` Masahiro Yamada
2021-04-09  3:12 ` Kees Cook

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20210407053419.449796-21-gregkh@linuxfoundation.org \
    --to=gregkh@linuxfoundation.org \
    --cc=linux-arch@vger.kernel.org \
    --cc=linux-kbuild@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=masahiroy@kernel.org \
    --cc=michal.lkml@markovi.net \
    --subject='Re: [PATCH 20/20] kbuild: scripts/install.sh: update documentation' \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.