[Buildroot] [PATCH v6 1/4] package/environment-setup: new package
Angelo Compagnucci
angelo at amarulasolutions.com
Tue Apr 28 14:45:58 UTC 2020
From: Angelo Compagnucci <angelo.compagnucci at gmail.com>
Install an helper script to setup a build environment based on buildroot.
It's useful when a developer wants to use a buildroot generated sdk to
build an external project.
Signed-off-by: Angelo Compagnucci <angelo at amarulasolutions.com>
---
Changelog:
v1->v2:
* Moved from echo to printf (Yann)
* removed sh extension (Yann)
* Adding missing script
v2->v3:
* Split the patch
v3->v4:
* Better handling of SDK_PATH dir (Mircea Gliga)
v4->v5:
* Cleaning the script using SDK_PATH where possible (Mircea Gliga)
v5->v6:
* Removed unused sed expressione (Mircea Gliga)
* Moved to be an host package
* fix PATH leaking: before path from the current user
can leak into the script
* Removed PS1
Some of the reason I kept several things the way I originally planned:
* I kept it being a package because it doesn't fit in any other tool:
indeed this script changes your current PATH and exports some
variables that can be used for anything.
Think of qmake or cmake or a package that doesn't have any
build system at all. It has some features geared
also towards autotools software but I keep planning others.
* I kept looping in TARGET_CONFIGURE_OPTS, indeed it produces a more
clean environment script at the end.
For the problem raised by Yann: variables in
TARGET_CONFIGURE_OPTS _are_ properly escaped, indeed if not, they
were a big source of problems on each ./configure invocation
due to the fact they are injected on the
./configure commandline invocation.
* I kept the manual entry: I think that the most documentation the
better.
docs/manual/using-buildroot-toolchain.txt | 8 ++++++
package/Config.in.host | 1 +
package/environment-setup/Config.in.host | 6 +++++
package/environment-setup/environment-setup | 16 ++++++++++++
package/environment-setup/environment-setup.mk | 34 ++++++++++++++++++++++++++
5 files changed, 65 insertions(+)
create mode 100644 package/environment-setup/Config.in.host
create mode 100644 package/environment-setup/environment-setup
create mode 100644 package/environment-setup/environment-setup.mk
diff --git a/docs/manual/using-buildroot-toolchain.txt b/docs/manual/using-buildroot-toolchain.txt
index 0c0c35f..98dae6c 100644
--- a/docs/manual/using-buildroot-toolchain.txt
+++ b/docs/manual/using-buildroot-toolchain.txt
@@ -27,6 +27,14 @@ Upon extracting the SDK tarball, the user must run the script
+relocate-sdk.sh+ (located at the top directory of the SDK), to make
sure all paths are updated with the new location.
+For your convenience, by selecting the host package
+BR2_PACKAGE_HOST_ENVIRONMENT_SETUP, you can have a +setup-environment+ script
+installed in +output/host/+.
+This script can be sourced with +. your/sdk/path/environment-setup+ to launch
+the buildroot shell. Inside this shell, you will find an environment already
+set up with the correct PATH and the complete list of +target configure
+options+.
+
Alternatively, if you just want to prepare the SDK without generating
the tarball (e.g. because you will just be moving the +host+ directory,
or will be generating the tarball on your own), Buildroot also allows
diff --git a/package/Config.in.host b/package/Config.in.host
index f1246c7..ba1dcb7 100644
--- a/package/Config.in.host
+++ b/package/Config.in.host
@@ -18,6 +18,7 @@ menu "Host utilities"
source "package/dtc/Config.in.host"
source "package/e2fsprogs/Config.in.host"
source "package/e2tools/Config.in.host"
+ source "package/environment-setup/Config.in.host"
source "package/erofs-utils/Config.in.host"
source "package/eudev/Config.in.host"
source "package/exfatprogs/Config.in.host"
diff --git a/package/environment-setup/Config.in.host b/package/environment-setup/Config.in.host
new file mode 100644
index 0000000..87f460d
--- /dev/null
+++ b/package/environment-setup/Config.in.host
@@ -0,0 +1,6 @@
+config BR2_PACKAGE_HOST_ENVIRONMENT_SETUP
+ bool "Environment setup"
+ help
+ Install an helper script to setup a build environment
+ based on buildroot. It's useful when you export an sdk
+ and want to use buildroot to build an external project
diff --git a/package/environment-setup/environment-setup b/package/environment-setup/environment-setup
new file mode 100644
index 0000000..b48f197
--- /dev/null
+++ b/package/environment-setup/environment-setup
@@ -0,0 +1,16 @@
+cat <<'EOF'
+ _ _ _ _ _
+| |__ _ _(_) | __| |_ __ ___ ___ | |_
+| '_ \| | | | | |/ _` | '__/ _ \ / _ \| __|
+| |_) | |_| | | | (_| | | | (_) | (_) | |_
+|_.__/ \__,_|_|_|\__,_|_| \___/ \___/ \__| shell
+
+ Making embedded Linux easy!
+
+Some tips:
+* PATH is now pointing to the HOST_DIR path
+* Target configure options are already exported
+* To configure do "./configure $CONFIGURE_FLAGS"
+
+EOF
+SDK_PATH=$(dirname $(realpath "${BASH_SOURCE[0]}"))
diff --git a/package/environment-setup/environment-setup.mk b/package/environment-setup/environment-setup.mk
new file mode 100644
index 0000000..6d2396f
--- /dev/null
+++ b/package/environment-setup/environment-setup.mk
@@ -0,0 +1,34 @@
+################################################################################
+#
+# environment-setup
+#
+################################################################################
+
+ENVIRONMENT_SETUP_FILE = $(HOST_DIR)/environment-setup
+ENVIRONMENT_SETUP_HOST_DIR_SED_EXP = 's+$(HOST_DIR)+\$$SDK_PATH+g'
+ENVIRONMENT_SETUP_HOST_BIN_DIR_SED_EXP = 's+$(HOST_DIR)/bin/++g'
+
+define HOST_ENVIRONMENT_SETUP_INSTALL_CMDS
+ cp package/environment-setup/environment-setup $(ENVIRONMENT_SETUP_FILE)
+ for var in $(TARGET_CONFIGURE_OPTS); do \
+ printf "export \"$$var\"\n" >> $(ENVIRONMENT_SETUP_FILE); \
+ done
+ printf "export \"CROSS_COMPILE=$(TARGET_CROSS)\"\n" >> $(ENVIRONMENT_SETUP_FILE)
+ printf "export \"CONFIGURE_FLAGS=--target=$(GNU_TARGET_NAME) \
+ --host=$(GNU_TARGET_NAME) \
+ --build=$(GNU_HOST_NAME) \
+ --prefix=/usr \
+ --exec-prefix=/usr \
+ --sysconfdir=/etc \
+ --localstatedir=/var \
+ --program-prefix=\"\n" >> $(ENVIRONMENT_SETUP_FILE)
+ $(SED) $(ENVIRONMENT_SETUP_HOST_BIN_DIR_SED_EXP) \
+ -e $(ENVIRONMENT_SETUP_HOST_DIR_SED_EXP) \
+ -e '/^export "PATH=/c\' \
+ $(ENVIRONMENT_SETUP_FILE)
+ printf "export \"PATH=\$$SDK_PATH/bin:\$$SDK_PATH/sbin:\$$PATH\"\n" \
+ >> $(ENVIRONMENT_SETUP_FILE)
+
+endef
+
+$(eval $(host-generic-package))
--
2.7.4
More information about the buildroot
mailing list