Merge branch 'RPi-Distro-master' into dev

Author: Landrash

README.md

@@ -89,7 +89,8 @@ A simple example for building Hassbian:
 =======
  * `USE_QEMU` (Default: `"0"`)
 
-   This enable the Qemu mode and set filesystem and image suffix if set to 1.
+   Setting to '1' enables the QEMU mode - creating an image that can be mounted via QEMU for an emulated
+   environment. These images include "-qemu" in the image file name.
 
 
 A simple example for building Raspbian:
@@ -117,7 +118,7 @@ The following process is followed to build images:
    There are a number of different files and directories which can be used to
    control different parts of the build process:
 
-     - **00-run.sh** - A unix shell script. Needs to be made executable for it to run
+     - **00-run.sh** - A unix shell script. Needs to be made executable for it to run.
 
      - **00-run-chroot.sh** - A unix shell script which will be run in the chroot
        of the image build directory. Needs to be made executable for it to run.
@@ -129,9 +130,12 @@ The following process is followed to build images:
        separated, per line.
 
      - **00-packages-nr** - As 00-packages, except these will be installed using
-       the ```--no-install-recommends -y``` parameters to apt-get
+       the ```--no-install-recommends -y``` parameters to apt-get.
 
-     - **00-patches** - A directory containing patch files to be applied
+     - **00-patches** - A directory containing patch files to be applied, using quilt.
+       If a file named 'EDIT' is present in the directory, the build process will
+       be interrupted with a bash session, allowing an opportunity to create/revise
+       the patches.
 
   * If the stage directory contains files called "EXPORT_NOOBS" or "EXPORT_IMAGE" then
     add this stage to a list of images to generate
@@ -158,6 +162,12 @@ continue:
 CONTINUE=1 ./build-docker.sh
 ```
 
+After successful build, the build container is by default removed. This may be undesired when making incremental changes to a customized build. To prevent the build script from remove the container add
+
+```bash
+PRESERVE_CONTAINER=1 ./build-docker.sh
+```
+
 There is a possibility that even when running from a docker container, the
 installation of `qemu-user-static` will silently fail when building the image
 because `binfmt-support` _must be enabled on the underlying kernel_. An easy
@@ -225,14 +235,14 @@ If you wish to build up to a specified stage (such as building up to stage 2
 for a lite system), place an empty file named `SKIP` in each of the `./stage`
 directories you wish not to include.
 
-Then remove the `EXPORT*` files from `./stage4` (if building up to stage 2) or
-from `./stage2` (if building a minimal system).
+Then add an empty file named `SKIP_IMAGES` to `./stage4` (if building up to stage 2) or
+to `./stage2` (if building a minimal system).
 
 ```bash
 # Example for building a lite system
 echo "IMG_NAME='Raspbian'" > config
 touch ./stage3/SKIP ./stage4/SKIP ./stage5/SKIP
-rm stage4/EXPORT* stage5/EXPORT*
+touch ./stage4/SKIP_IMAGES ./stage5/SKIP_IMAGES
 sudo ./build.sh  # or ./build-docker.sh
 ```
 

build-docker.sh

@@ -21,6 +21,7 @@ fi
 
 CONTAINER_NAME=${CONTAINER_NAME:-pigen_work}
 CONTINUE=${CONTINUE:-0}
+PRESERVE_CONTAINER=${PRESERVE_CONTAINER:-0}
 
 if [ "$*" != "" ] || [ -z "${IMG_NAME}" ]; then
 	if [ -z "${IMG_NAME}" ]; then
@@ -33,6 +34,7 @@ Usage:
 Optional environment arguments: ( =<default> )
     CONTAINER_NAME=pigen_work  set a name for the build container
     CONTINUE=1                 continue from a previously started container
+    PRESERVE_CONTAINER=1       keep build container even on successful build
 EOF
 	exit 1
 fi
@@ -55,7 +57,7 @@ if [ "$CONTAINER_EXISTS" != "" ]; then
 	trap "echo 'got CTRL+C... please wait 5s'; $DOCKER stop -t 5 ${CONTAINER_NAME}_cont" SIGINT SIGTERM
 	time $DOCKER run --rm --privileged \
 		--volumes-from="${CONTAINER_NAME}" --name "${CONTAINER_NAME}_cont" \
-		-e IMG_NAME=${IMG_NAME}\
+		-e IMG_NAME="${IMG_NAME}"\
 		pi-gen \
 		bash -e -o pipefail -c "dpkg-reconfigure qemu-user-static &&
 	cd /pi-gen; ./build.sh;
@@ -64,7 +66,7 @@ if [ "$CONTAINER_EXISTS" != "" ]; then
 else
 	trap "echo 'got CTRL+C... please wait 5s'; $DOCKER stop -t 5 ${CONTAINER_NAME}" SIGINT SIGTERM
 	time $DOCKER run --name "${CONTAINER_NAME}" --privileged \
-		-e IMG_NAME=${IMG_NAME}\
+		-e IMG_NAME="${IMG_NAME}"\
 		"${config_file[@]}" \
 		pi-gen \
 		bash -e -o pipefail -c "dpkg-reconfigure qemu-user-static &&
@@ -75,6 +77,10 @@ fi
 echo "copying results from deploy/"
 $DOCKER cp "${CONTAINER_NAME}":/pi-gen/deploy .
 ls -lah deploy
-$DOCKER rm -v $CONTAINER_NAME
+
+# cleanup
+if [ "$PRESERVE_CONTAINER" != "1" ]; then
+	$DOCKER rm -v $CONTAINER_NAME
+fi
 
 echo "Done! Your image(s) should be in deploy/"

build.sh

@@ -1,51 +1,52 @@
 #!/bin/bash -e
-
+# shellcheck disable=SC2119,SC1091
 run_sub_stage()
 {
 	log "Begin ${SUB_STAGE_DIR}"
-	pushd ${SUB_STAGE_DIR} > /dev/null
+	pushd "${SUB_STAGE_DIR}" > /dev/null
 	for i in {00..99}; do
-		if [ -f ${i}-debconf ]; then
+		if [ -f "${i}-debconf" ]; then
 			log "Begin ${SUB_STAGE_DIR}/${i}-debconf"
 			on_chroot << EOF
 debconf-set-selections <<SELEOF
-`cat ${i}-debconf`
+$(cat "${i}-debconf")
 SELEOF
 EOF
+
 		log "End ${SUB_STAGE_DIR}/${i}-debconf"
 		fi
-		if [ -f ${i}-packages-nr ]; then
+		if [ -f "${i}-packages-nr" ]; then
 			log "Begin ${SUB_STAGE_DIR}/${i}-packages-nr"
-			PACKAGES="$(sed -f "${SCRIPT_DIR}/remove-comments.sed" < ${i}-packages-nr)"
+			PACKAGES="$(sed -f "${SCRIPT_DIR}/remove-comments.sed" < "${i}-packages-nr")"
 			if [ -n "$PACKAGES" ]; then
 				on_chroot << EOF
 apt-get install --no-install-recommends -y $PACKAGES
 EOF
 			fi
 			log "End ${SUB_STAGE_DIR}/${i}-packages-nr"
 		fi
-		if [ -f ${i}-packages ]; then
+		if [ -f "${i}-packages" ]; then
 			log "Begin ${SUB_STAGE_DIR}/${i}-packages"
-			PACKAGES="$(sed -f "${SCRIPT_DIR}/remove-comments.sed" < ${i}-packages)"
+			PACKAGES="$(sed -f "${SCRIPT_DIR}/remove-comments.sed" < "${i}-packages")"
 			if [ -n "$PACKAGES" ]; then
 				on_chroot << EOF
 apt-get install -y $PACKAGES
 EOF
 			fi
 			log "End ${SUB_STAGE_DIR}/${i}-packages"
 		fi
-		if [ -d ${i}-patches ]; then
+		if [ -d "${i}-patches" ]; then
 			log "Begin ${SUB_STAGE_DIR}/${i}-patches"
-			pushd ${STAGE_WORK_DIR} > /dev/null
+			pushd "${STAGE_WORK_DIR}" > /dev/null
 			if [ "${CLEAN}" = "1" ]; then
 				rm -rf .pc
-				rm -rf *-pc
+				rm -rf ./*-pc
 			fi
-			QUILT_PATCHES=${SUB_STAGE_DIR}/${i}-patches
-			SUB_STAGE_QUILT_PATCH_DIR="$(basename $SUB_STAGE_DIR)-pc"
-			mkdir -p $SUB_STAGE_QUILT_PATCH_DIR
-			ln -snf $SUB_STAGE_QUILT_PATCH_DIR .pc
-			if [ -e ${SUB_STAGE_DIR}/${i}-patches/EDIT ]; then
+			QUILT_PATCHES="${SUB_STAGE_DIR}/${i}-patches"
+			SUB_STAGE_QUILT_PATCH_DIR="$(basename "$SUB_STAGE_DIR")-pc"
+			mkdir -p "$SUB_STAGE_QUILT_PATCH_DIR"
+			ln -snf "$SUB_STAGE_QUILT_PATCH_DIR" .pc
+			if [ -e "${SUB_STAGE_DIR}/${i}-patches/EDIT" ]; then
 				echo "Dropping into bash to edit patches..."
 				bash
 			fi
@@ -80,20 +81,20 @@ EOF
 
 run_stage(){
 	log "Begin ${STAGE_DIR}"
-	STAGE=$(basename ${STAGE_DIR})
-	pushd ${STAGE_DIR} > /dev/null
-	unmount ${WORK_DIR}/${STAGE}
-	STAGE_WORK_DIR=${WORK_DIR}/${STAGE}
-	ROOTFS_DIR=${STAGE_WORK_DIR}/rootfs
+	STAGE="$(basename "${STAGE_DIR}")"
+	pushd "${STAGE_DIR}" > /dev/null
+	unmount "${WORK_DIR}/${STAGE}"
+	STAGE_WORK_DIR="${WORK_DIR}/${STAGE}"
+	ROOTFS_DIR="${STAGE_WORK_DIR}"/rootfs
 	if [ ! -f SKIP_IMAGES ]; then
-		if [ -f ${STAGE_DIR}/EXPORT_IMAGE ]; then
+		if [ -f "${STAGE_DIR}/EXPORT_IMAGE" ]; then
 			EXPORT_DIRS="${EXPORT_DIRS} ${STAGE_DIR}"
 		fi
 	fi
 	if [ ! -f SKIP ]; then
 		if [ "${CLEAN}" = "1" ]; then
-			if [ -d ${ROOTFS_DIR} ]; then
-				rm -rf ${ROOTFS_DIR}
+			if [ -d "${ROOTFS_DIR}" ]; then
+				rm -rf "${ROOTFS_DIR}"
 			fi
 		fi
 		if [ -x prerun.sh ]; then
@@ -102,16 +103,16 @@ run_stage(){
 			log "End ${STAGE_DIR}/prerun.sh"
 		fi
 		for SUB_STAGE_DIR in ${STAGE_DIR}/*; do
-			if [ -d ${SUB_STAGE_DIR} ] &&
-			   [ ! -f ${SUB_STAGE_DIR}/SKIP ]; then
+			if [ -d "${SUB_STAGE_DIR}" ] &&
+			   [ ! -f "${SUB_STAGE_DIR}/SKIP" ]; then
 				run_sub_stage
 			fi
 		done
 	fi
-	unmount ${WORK_DIR}/${STAGE}
-	PREV_STAGE=${STAGE}
-	PREV_STAGE_DIR=${STAGE_DIR}
-	PREV_ROOTFS_DIR=${ROOTFS_DIR}
+	unmount "${WORK_DIR}/${STAGE}"
+	PREV_STAGE="${STAGE}"
+	PREV_STAGE_DIR="${STAGE_DIR}"
+	PREV_ROOTFS_DIR="${ROOTFS_DIR}"
 	popd > /dev/null
 	log "End ${STAGE_DIR}"
 }
@@ -131,15 +132,17 @@ if [ -z "${IMG_NAME}" ]; then
 	exit 1
 fi
 
-export USE_QEMU=${USE_QEMU:-0}
-export IMG_DATE=${IMG_DATE:-"$(date +%Y-%m-%d)"}
+export USE_QEMU="${USE_QEMU:-0}"
+export IMG_DATE="${IMG_DATE:-"$(date +%Y-%m-%d)"}"
 
-export BASE_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+BASE_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
 export SCRIPT_DIR="${BASE_DIR}/scripts"
-export WORK_DIR=${WORK_DIR:-"${BASE_DIR}/work/${IMG_DATE}-${IMG_NAME}"}
+export WORK_DIR="${WORK_DIR:-"${BASE_DIR}/work/${IMG_DATE}-${IMG_NAME}"}"
 export DEPLOY_DIR=${DEPLOY_DIR:-"${BASE_DIR}/deploy"}
 export LOG_FILE="${WORK_DIR}/build.log"
 
+export BASE_DIR
+
 export CLEAN
 export IMG_NAME
 export APT_PROXY
@@ -162,29 +165,33 @@ export QUILT_NO_DIFF_INDEX=1
 export QUILT_NO_DIFF_TIMESTAMPS=1
 export QUILT_REFRESH_ARGS="-p ab"
 
-source ${SCRIPT_DIR}/common
-source ${SCRIPT_DIR}/dependencies_check
+# shellcheck source=scripts/common
+source "${SCRIPT_DIR}/common"
+# shellcheck source=scripts/dependencies_check
+source "${SCRIPT_DIR}/dependencies_check"
 
 
-dependencies_check ${BASE_DIR}/depends
+dependencies_check "${BASE_DIR}/depends"
 
-mkdir -p ${WORK_DIR}
+mkdir -p "${WORK_DIR}"
 log "Begin ${BASE_DIR}"
 
-for STAGE_DIR in ${BASE_DIR}/stage*; do
+for STAGE_DIR in "${BASE_DIR}/stage"*; do
 	run_stage
 done
 
 CLEAN=1
 for EXPORT_DIR in ${EXPORT_DIRS}; do
 	STAGE_DIR=${BASE_DIR}/export-image
+	# shellcheck source=/dev/null
 	source "${EXPORT_DIR}/EXPORT_IMAGE"
-	EXPORT_ROOTFS_DIR=${WORK_DIR}/$(basename ${EXPORT_DIR})/rootfs
+	EXPORT_ROOTFS_DIR=${WORK_DIR}/$(basename "${EXPORT_DIR}")/rootfs
 	run_stage
 	if [ "${USE_QEMU}" != "1" ]; then
-		if [ -e ${EXPORT_DIR}/EXPORT_NOOBS ]; then
-			source ${EXPORT_DIR}/EXPORT_NOOBS
-			STAGE_DIR=${BASE_DIR}/export-noobs
+		if [ -e "${EXPORT_DIR}/EXPORT_NOOBS" ]; then
+			# shellcheck source=/dev/null
+			source "${EXPORT_DIR}/EXPORT_NOOBS"
+			STAGE_DIR="${BASE_DIR}/export-noobs"
 			run_stage
 		fi
 	fi

export-image/00-allow-rerun/00-run.sh

@@ -1,5 +1,5 @@
 #!/bin/bash -e
 
-if [ ! -x ${ROOTFS_DIR}/usr/bin/qemu-arm-static ]; then
-	cp /usr/bin/qemu-arm-static ${ROOTFS_DIR}/usr/bin/
+if [ ! -x "${ROOTFS_DIR}/usr/bin/qemu-arm-static" ]; then
+	cp /usr/bin/qemu-arm-static "${ROOTFS_DIR}/usr/bin/"
 fi

export-image/02-network/01-run.sh

@@ -1,3 +1,3 @@
 #!/bin/bash -e
 
-install -m 644 files/resolv.conf ${ROOTFS_DIR}/etc/
+install -m 644 files/resolv.conf "${ROOTFS_DIR}/etc/"

export-image/03-set-partuuid/00-run.sh

@@ -2,12 +2,12 @@
 
 IMG_FILE="${STAGE_WORK_DIR}/${IMG_DATE}-${IMG_NAME}${IMG_SUFFIX}.img"
 
-IMGID="$(dd if=${IMG_FILE} skip=440 bs=1 count=4 2>/dev/null | xxd -e | cut -f 2 -d' ')"
+IMGID="$(dd if="${IMG_FILE}" skip=440 bs=1 count=4 2>/dev/null | xxd -e | cut -f 2 -d' ')"
 
 BOOT_PARTUUID="${IMGID}-01"
 ROOT_PARTUUID="${IMGID}-02"
 
-sed -i "s/BOOTDEV/PARTUUID=${BOOT_PARTUUID}/" ${ROOTFS_DIR}/etc/fstab
-sed -i "s/ROOTDEV/PARTUUID=${ROOT_PARTUUID}/" ${ROOTFS_DIR}/etc/fstab
+sed -i "s/BOOTDEV/PARTUUID=${BOOT_PARTUUID}/" "${ROOTFS_DIR}/etc/fstab"
+sed -i "s/ROOTDEV/PARTUUID=${ROOT_PARTUUID}/" "${ROOTFS_DIR}/etc/fstab"
 
-sed -i "s/ROOTDEV/PARTUUID=${ROOT_PARTUUID}/" ${ROOTFS_DIR}/boot/cmdline.txt
+sed -i "s/ROOTDEV/PARTUUID=${ROOT_PARTUUID}/" "${ROOTFS_DIR}/boot/cmdline.txt"