live-build/scripts/build/binary_netboot

#!/bin/sh

## live-build(7) - System Build Scripts
## Copyright (C) 2016-2020 The Debian Live team
## Copyright (C) 2006-2015 Daniel Baumann <mail@daniel-baumann.ch>
##
## This program comes with ABSOLUTELY NO WARRANTY; for details see COPYING.
## This is free software, and you are welcome to redistribute it
## under certain conditions; see COPYING for details.


set -e

# Including common functions
[ -e "${LIVE_BUILD}/scripts/build.sh" ] && . "${LIVE_BUILD}/scripts/build.sh" || . /usr/lib/live/build.sh

# Setting static variables
DESCRIPTION="Build netboot binary image"
USAGE="${PROGRAM} [--force]"

# Processing arguments and configuration files
Init_config_data "${@}"

if [ "${LB_IMAGE_TYPE}" != "netboot" ]; then
	exit 0
fi

if [ "${LB_NET_TARBALL}" = "false" ]
then
	exit 0
fi

Echo_message "Begin building binary netboot image..."

# Requiring stage file
Require_stagefiles config bootstrap

# Checking stage file
Check_stagefile

# Acquire lock file
Acquire_lockfile

# Remove old binary
rm -f ${LB_IMAGE_NAME}-${LB_ARCHITECTURE}.netboot.tar ${LB_IMAGE_NAME}-${LB_ARCHITECTURE}.netboot.tar.gz ${LB_IMAGE_NAME}-${LB_ARCHITECTURE}.netboot.tar.bz2 ${LB_IMAGE_NAME}-${LB_ARCHITECTURE}.netboot.tar.xz ${LB_IMAGE_NAME}-${LB_ARCHITECTURE}.netboot.tar.xz

# Creating image file
ROOT_DIR=${LB_MODE}-live

mv binary ${ROOT_DIR}

mkdir binary.tmp
mv ${ROOT_DIR} tftpboot binary.tmp
cd binary.tmp

# Moving kernel and initrd image arround
mkdir tftpboot/live
mv */live/vmlinuz* */live/initrd* tftpboot/live

tar cf ../${LB_IMAGE_NAME}-${LB_ARCHITECTURE}.netboot.tar *

case "${LB_COMPRESSION}" in
	bzip2)
		bzip2 ${BZIP2_OPTIONS} ../${LB_IMAGE_NAME}-${LB_ARCHITECTURE}.netboot.tar
		;;

	gzip)
		gzip ${GZIP_OPTIONS} ../${LB_IMAGE_NAME}-${LB_ARCHITECTURE}.netboot.tar
		;;

	lzip)
		lzip ${LZIP_OPTIONS} ../${LB_IMAGE_NAME}-${LB_ARCHITECTURE}.netboot.tar
		;;

	xz)
		xz ${XZ_OPTIONS} ../${LB_IMAGE_NAME}-${LB_ARCHITECTURE}.netboot.tar
		;;

	none)
		;;
esac

mv * ../
cd "${OLDPWD}"
rmdir binary.tmp

mv ${ROOT_DIR} binary

# Creating stage file
Create_stagefile
Adding live-helper 1.0~a1-1. 2007-09-23 08:04:46 +00:00			`#!/bin/sh`

Updating copyright headers for live-build. 2010-09-02 11:12:37 +00:00			`## live-build(7) - System Build Scripts`
amend copyright & licensing blocks Current versions of the project files are built upon versions published and licensed by Daniel Baumann, but are modified copies of those files and thus need to be marked as such per licensing requirements (afaik he did not pass along ownership / licensing rights to anyone when he left the project). We should also be careful to not be misrepresenting such modified copies as being attributed to Daniel. Adding a new copyright line referring to "The Debian Live team" should suffice for this. The authorship block in man pages has also similarly been updated. Notes: - tweaked a copy of daniel copyright lines stating 2014 instead of 2015. both of these cases were in files that i had personally introduced in some of my past merged commits that moved some code around. i don't know why they stated 2014. - binary_onie was introduced in 2018, so that has a 2018 date instead of 2016 unlike the rest. - 'efi-image' is a 3rd-party (Canonical Ltd) work that we bundle, but it has been modified by 674794a8f4d61a729d2dbd6d99385d2826138694 and 36a3ba76347ef72df1c316312ed3a26aa4b0c816 so I similarly added a debian live copyright line. - 'grub-cpmodules' is similar. it was only changed by the indentation fix of 36a3ba76347ef72df1c316312ed3a26aa4b0c816 but modification is modification, and this does help cover any possible future changes that might be made. 2020-03-11 09:07:21 -01:00			`## Copyright (C) 2016-2020 The Debian Live team`
Updating year in copyright notices to 2015. 2015-01-04 18:05:39 -01:00			`## Copyright (C) 2006-2015 Daniel Baumann <mail@daniel-baumann.ch>`
Updating copyright headers for live-build. 2010-09-02 11:12:37 +00:00			`##`
Updating GPL standard header in all files. 2012-07-29 23:59:00 +00:00			`## This program comes with ABSOLUTELY NO WARRANTY; for details see COPYING.`
Updating copyright headers for live-build. 2010-09-02 11:12:37 +00:00			`## This is free software, and you are welcome to redistribute it`
			`## under certain conditions; see COPYING for details.`

Adding live-helper 1.0~a1-1. 2007-09-23 08:04:46 +00:00
			`set -e`

Adding live-helper 1.0~a13-1. 2007-09-23 08:05:11 +00:00			`# Including common functions`
Making build.sh sourcing more robust (Closes: #684896). 2012-08-27 13:52:29 +00:00			`[ -e "${LIVE_BUILD}/scripts/build.sh" ] && . "${LIVE_BUILD}/scripts/build.sh" \|\| . /usr/lib/live/build.sh`
Adding live-helper 1.0~a1-1. 2007-09-23 08:04:46 +00:00
Adding live-helper 1.0~a13-1. 2007-09-23 08:05:11 +00:00			`# Setting static variables`
help/usage: fix overly complex script description handling Closes: #952887 2015-02-05 02:30:47 -01:00			`DESCRIPTION="Build netboot binary image"`
Adding live-helper 1.0~a3-1. 2007-09-23 08:04:48 +00:00			`USAGE="${PROGRAM} [--force]"`

tidy script init (1/4) - arg and config processing Partial fix for #952919 Gbp-Dch: Short 2015-02-05 02:30:47 -01:00			`# Processing arguments and configuration files`
			`Init_config_data "${@}"`
Adding live-helper 1.0~a1-1. 2007-09-23 08:04:46 +00:00
config: s/LIVE_IMAGE_TYPE/LB_IMAGE_TYPE/ no backwards compatibility hack for reading the old var from existing saved config used because this was previously stored in the alternate format config/build file. Gbp-Dch: Short 2020-04-06 17:46:47 +00:00			`if [ "${LB_IMAGE_TYPE}" != "netboot" ]; then`
Adding live-helper 1.0~a13-1. 2007-09-23 08:05:11 +00:00			`exit 0`
			`fi`
Adding live-helper 1.0~a5-1. 2007-09-23 08:04:49 +00:00
Generalizing compression handling and adding support for lzip tarballs. 2011-01-01 22:36:20 -01:00			`if [ "${LB_NET_TARBALL}" = "false" ]`
Adding option to set binary-net compression (or disable it). 2008-02-26 17:57:41 -01:00			`then`
			`exit 0`
			`fi`

Adding live-helper 1.0~a13-1. 2007-09-23 08:05:11 +00:00			`Echo_message "Begin building binary netboot image..."`
Adding live-helper 1.0~a3-1. 2007-09-23 08:04:48 +00:00
Adding live-helper 1.0~a13-1. 2007-09-23 08:05:11 +00:00			`# Requiring stage file`
stagefiles: s/Require_stagefile/Require_stagefiles/ this function takes one or more required stage fileS _plural_, and exits if any are missing (or at least it does now after the refactor). let's rename it to make things more clear Gbp-Dch: Short 2020-03-15 12:05:44 -01:00			`Require_stagefiles config bootstrap`
Adding live-helper 1.0~a6-1. 2007-09-23 08:04:50 +00:00
Adding live-helper 1.0~a13-1. 2007-09-23 08:05:11 +00:00			`# Checking stage file`
stagefiles: further robustify with auto filenames as suggested by Raphaël rather than have fixed stagefile filename strings at all in the scripts, use `$(basename $0)` to use the name of the script (which is the same for almost all cases anyway, and the stage files are supposed to be almost exclusively unique per-script). we can thus simplify things by determining the filename for most use cases within the functions themselves. this does change the file used by a couple of scripts, affecting backwards compatibility of executing live-build upon an existing partially or fully completed build: - binary_grub-pc used "binary_grub" - chroot_includes used "includes.chroot" care had to be taken for the following cases: - there are some cases like bootstrap_cache, source_debian and bootstrap_debootstrap which are dealing with more than one file, and/or otherwise a filename that is not specific to the script itself exactly, or should not be based upon its name. - some cases like chroot_cache, bootstrap_cache and chroot_install-packages need to append something to the end of the name depending upon which pass/action mode the script is being executed with. - furthermore in the bootstrap_cache case one of the filenames is used within the bootstrap_debootstrap and thus needs very careful handling to be certain that a change in filename of bootstrap_cache does not break bootstrap_debootstrap. Gbp-Dch: Short 2020-03-13 16:11:53 -01:00			`Check_stagefile`
Adding live-helper 1.0~a3-1. 2007-09-23 08:04:48 +00:00
fix comment typo Gbp-Dch: Ignore 2020-03-13 15:19:59 -01:00			`# Acquire lock file`
locks: tidy lock acquisition Combine the check+create done in each script. (The original functions are still callable as before, but a new combined `Aquire_lockfile` function can be called instead, as now used). Note, a further simplification could be done in removing the passing of the lock filename in as a parameter since every use of the functions is with ".lock". The lock functions already have a fallback to ".build/lock" though. Checking the history, the fallback used to be for a system wide lock, which was then replaced with this config-tree specific one. As long as that is not used implicitly by 3rd-party hooks then surely we are free to change the fallback to ".lock" and further remove passing in a name as a param...? history: db5d2b0dcdae96e712661605e17bc9875e224f9f 0aa8289a3773fd8a3885090b72622c2f95ab099c Gbp-Dch: Short Closes: #952918 2015-02-05 02:30:47 -01:00			`Acquire_lockfile`
Adding live-helper 1.0~a1-1. 2007-09-23 08:04:46 +00:00
Adding live-helper 1.0~a13-1. 2007-09-23 08:05:11 +00:00			`# Remove old binary`
config: s/LIVE_IMAGE_NAME/LB_IMAGE_NAME/ no backwards compatibility hack for reading the old var from existing saved config used because this was previously stored in the alternate format config/build file. Gbp-Dch: Short 2020-04-06 17:43:41 +00:00			`rm -f ${LB_IMAGE_NAME}-${LB_ARCHITECTURE}.netboot.tar ${LB_IMAGE_NAME}-${LB_ARCHITECTURE}.netboot.tar.gz ${LB_IMAGE_NAME}-${LB_ARCHITECTURE}.netboot.tar.bz2 ${LB_IMAGE_NAME}-${LB_ARCHITECTURE}.netboot.tar.xz ${LB_IMAGE_NAME}-${LB_ARCHITECTURE}.netboot.tar.xz`
Adding live-helper 1.0~a5-1. 2007-09-23 08:04:49 +00:00
Adding live-helper 1.0~a13-1. 2007-09-23 08:05:11 +00:00			`# Creating image file`
config: obsolete --net-root-path 2020-04-23 13:44:17 +00:00			`ROOT_DIR=${LB_MODE}-live`
Generalizing compression handling and adding support for lzip tarballs. 2011-01-01 22:36:20 -01:00
config: obsolete --net-root-path 2020-04-23 13:44:17 +00:00			`mv binary ${ROOT_DIR}`
Adding live-helper 1.0~a2-1. 2007-09-23 08:04:47 +00:00
Correcting path within netboot tarballs. 2009-02-14 15:40:43 -01:00			`mkdir binary.tmp`
			`mv ${ROOT_DIR} tftpboot binary.tmp`
			`cd binary.tmp`
Adding option to set binary-net compression (or disable it). 2008-02-26 17:57:41 -01:00
Moving kernel and initrd into tftpboot directory for netboot images. 2012-04-04 14:45:10 +00:00			`# Moving kernel and initrd image arround`
			`mkdir tftpboot/live`
			`mv /live/vmlinuz /live/initrd tftpboot/live`

config: s/LIVE_IMAGE_NAME/LB_IMAGE_NAME/ no backwards compatibility hack for reading the old var from existing saved config used because this was previously stored in the alternate format config/build file. Gbp-Dch: Short 2020-04-06 17:43:41 +00:00			`tar cf ../${LB_IMAGE_NAME}-${LB_ARCHITECTURE}.netboot.tar *`
Generalizing compression handling and adding support for lzip tarballs. 2011-01-01 22:36:20 -01:00
Correcting compression handling for tarballs. 2011-01-07 21:39:41 -01:00			`case "${LB_COMPRESSION}" in`
Adding option to set binary-net compression (or disable it). 2008-02-26 17:57:41 -01:00			`bzip2)`
config: s/LIVE_IMAGE_NAME/LB_IMAGE_NAME/ no backwards compatibility hack for reading the old var from existing saved config used because this was previously stored in the alternate format config/build file. Gbp-Dch: Short 2020-04-06 17:43:41 +00:00			`bzip2 ${BZIP2_OPTIONS} ../${LB_IMAGE_NAME}-${LB_ARCHITECTURE}.netboot.tar`
Adding option to set binary-net compression (or disable it). 2008-02-26 17:57:41 -01:00			`;;`

			`gzip)`
config: s/LIVE_IMAGE_NAME/LB_IMAGE_NAME/ no backwards compatibility hack for reading the old var from existing saved config used because this was previously stored in the alternate format config/build file. Gbp-Dch: Short 2020-04-06 17:43:41 +00:00			`gzip ${GZIP_OPTIONS} ../${LB_IMAGE_NAME}-${LB_ARCHITECTURE}.netboot.tar`
Adding option to set binary-net compression (or disable it). 2008-02-26 17:57:41 -01:00			`;;`

Generalizing compression handling and adding support for lzip tarballs. 2011-01-01 22:36:20 -01:00			`lzip)`
config: s/LIVE_IMAGE_NAME/LB_IMAGE_NAME/ no backwards compatibility hack for reading the old var from existing saved config used because this was previously stored in the alternate format config/build file. Gbp-Dch: Short 2020-04-06 17:43:41 +00:00			`lzip ${LZIP_OPTIONS} ../${LB_IMAGE_NAME}-${LB_ARCHITECTURE}.netboot.tar`
Generalizing compression handling and adding support for lzip tarballs. 2011-01-01 22:36:20 -01:00			`;;`

Adding xz as valid compression format. 2012-07-18 17:44:00 +00:00			`xz)`
config: s/LIVE_IMAGE_NAME/LB_IMAGE_NAME/ no backwards compatibility hack for reading the old var from existing saved config used because this was previously stored in the alternate format config/build file. Gbp-Dch: Short 2020-04-06 17:43:41 +00:00			`xz ${XZ_OPTIONS} ../${LB_IMAGE_NAME}-${LB_ARCHITECTURE}.netboot.tar`
Adding xz as valid compression format. 2012-07-18 17:44:00 +00:00			`;;`

Generalizing compression handling and adding support for lzip tarballs. 2011-01-01 22:36:20 -01:00			`none)`
Adding option to set binary-net compression (or disable it). 2008-02-26 17:57:41 -01:00			`;;`
			`esac`

Correcting path within netboot tarballs. 2009-02-14 15:40:43 -01:00			`mv * ../`
Adding live-helper 1.0~a13-1. 2007-09-23 08:05:11 +00:00			`cd "${OLDPWD}"`
Correcting path within netboot tarballs. 2009-02-14 15:40:43 -01:00			`rmdir binary.tmp`
Adding live-helper 1.0~a1-1. 2007-09-23 08:04:46 +00:00
config: obsolete --net-root-path 2020-04-23 13:44:17 +00:00			`mv ${ROOT_DIR} binary`
Adding live-helper 1.0~a13-1. 2007-09-23 08:05:11 +00:00
			`# Creating stage file`
stagefiles: further robustify with auto filenames as suggested by Raphaël rather than have fixed stagefile filename strings at all in the scripts, use `$(basename $0)` to use the name of the script (which is the same for almost all cases anyway, and the stage files are supposed to be almost exclusively unique per-script). we can thus simplify things by determining the filename for most use cases within the functions themselves. this does change the file used by a couple of scripts, affecting backwards compatibility of executing live-build upon an existing partially or fully completed build: - binary_grub-pc used "binary_grub" - chroot_includes used "includes.chroot" care had to be taken for the following cases: - there are some cases like bootstrap_cache, source_debian and bootstrap_debootstrap which are dealing with more than one file, and/or otherwise a filename that is not specific to the script itself exactly, or should not be based upon its name. - some cases like chroot_cache, bootstrap_cache and chroot_install-packages need to append something to the end of the name depending upon which pass/action mode the script is being executed with. - furthermore in the bootstrap_cache case one of the filenames is used within the bootstrap_debootstrap and thus needs very careful handling to be certain that a change in filename of bootstrap_cache does not break bootstrap_debootstrap. Gbp-Dch: Short 2020-03-13 16:11:53 -01:00			`Create_stagefile`