diff mbox series

[20/20] kbuild: scripts/install.sh: update documentation

Message ID 20210407053419.449796-21-gregkh@linuxfoundation.org (mailing list archive)
State New
Headers show
Series kbuild: unify the install.sh script usage | expand

Commit Message

Greg KH April 7, 2021, 5:34 a.m. UTC
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(-)

Comments

Masahiro Yamada April 7, 2021, 11:45 a.m. UTC | #1
On Wed, Apr 7, 2021 at 2:35 PM Greg Kroah-Hartman
<gregkh@linuxfoundation.org> wrote:
>
> 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

Perhaps, this line can go to
"10/20 kbuild: arm: use common install script"  ?




> +# Adapted from code in arch/arm/boot/install.sh by Stuart Menefy

I think this line came from 18/20,
but do we need to keep it?

You removed arch/sh/boot/compressed/install.sh entirely.



>  #
> -# "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."


Since you soften the message, I guess this is not a warning message.
I assume it is intentional to put it in stdout instead of stderr.


>                 fi
>                 ;;
>  esac
> --
> 2.31.1
>
diff mbox series

Patch

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