From 8862e4d9ff15b44daa8563872fc928a3317e33dc Mon Sep 17 00:00:00 2001 From: Romain Bazile Date: Wed, 2 Feb 2022 14:10:24 +0100 Subject: [PATCH] Add check and warning for a space presence in the base path --- README.md | 18 ++++++++++++++++++ build.sh | 8 ++++++++ 2 files changed, 26 insertions(+) diff --git a/README.md b/README.md index e1676bb..893a5cc 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,24 @@ qemu-utils kpartx The file `depends` contains a list of tools needed. The format of this package is `[:]`. +## Getting started with building your images + +Getting started is as simple as cloning this repository on your build machine. You +can do so with: + +```bash +git clone -–depth 1 https://github.com/RPI-Distro/pi-gen.git +``` + +Using `--depth 1` with `git clone` will create a shallow clone, only containing +the latest revision of the repository. Do not do this on your development machine. + +Also, be careful to clone the repository to a base path **NOT** containing spaces. +This configuration is not supported by debootstrap and will lead to `pi-gen` not +running. + +After cloning the repository, you can move to the next step and start configuring +your build. ## Config diff --git a/build.sh b/build.sh index 6f6a0d2..f743e2a 100755 --- a/build.sh +++ b/build.sh @@ -155,6 +155,14 @@ if [ "$(id -u)" != "0" ]; then fi BASE_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)" + +if [[ $BASE_DIR = *" "* ]]; then + echo "There is a space in the base path of pi-gen" + echo "This is not a valid setup supported by debootstrap." + echo "Please remove the spaces, or move pi-gen directory to a base path without spaces" 1>&2 + exit 1 +fi + export BASE_DIR if [ -f config ]; then