Skip to contentSkip to conversation

package/environment-setup: new package

PATCH Superseded Angelo Compagnucci 3 participants 6 messages Apr 25, 2020 – Apr 28, 2020

v4 of 5 Superseded Latest is v5 →

lore
Share & tools
lore
#0 lore raw

PATCH v4 1/3 package/environment-setup: new package

From: Angelo Compagnucci <[email protected]>

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.
Due to the nature of the intrusiveness of this script, a new PS1 is installed to let the user understand that the current running shell is not a normal shell.

---
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)

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 curent 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 the script being installed in host root: other build system does that and I want this script to mimic other build systems.
* I kept looping in TARGET_CONFIGURE_OPTS, indeed it produces a more clean environment script at the end. For the problem arised 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 PS1: this script heavily mess with the path, it is expected by the user running it, but it can be very confusing being on a shell that doesn't behaves like your normal shell. So having a different PS1 helps remembering you are running into the buildroot shell and not into an ordinary one (other build systems does the same).
* I kept the manual entry: I think that the most documentation the better.

 docs/manual/using-buildroot-toolchain.txt     |  7 +++++
 package/Config.in                             |  1 +
 package/environment-setup/Config.in           |  6 ++++
 package/environment-setup/environment-setup   | 16 ++++++++++
 .../environment-setup/environment-setup.mk    | 29 +++++++++++++++++++
 5 files changed, 59 insertions(+)
 create mode 100644 package/environment-setup/Config.in
 create mode 100644 package/environment-setup/environment-setup
 create mode 100644 package/environment-setup/environment-setup.mk
docs/manual/using-buildroot-toolchain.txt +7 -0
index 0c0c35fced..7b2de4bdfa 100644
@@ -27,6 +27,13 @@ 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 package BR2_PACKAGE_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
package/Config.in +1 -0
index 9a6461277e..81f45bfaaf 100644
@@ -1953,6 +1953,7 @@ menu "Miscellaneous"
 	source "package/collectl/Config.in"
 	source "package/domoticz/Config.in"
 	source "package/empty/Config.in"
+	source "package/environment-setup/Config.in"
 	source "package/gnuradio/Config.in"
 	source "package/googlefontdirectory/Config.in"
 	source "package/gqrx/Config.in"
package/environment-setup/Config.in new file +6 -0
new file mode 100644
index 0000000000..f0fcc7d0f8
@@ -0,0 +1,6 @@
+config BR2_PACKAGE_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
package/environment-setup/environment-setup new file +16 -0
new file mode 100644
index 0000000000..b48f1979d6
@@ -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]}"))
package/environment-setup/environment-setup.mk new file +29 -0
new file mode 100644
index 0000000000..fc74594459
@@ -0,0 +1,29 @@
+################################################################################
+#
+# environment-setup
+#
+################################################################################
+
+ENVIRONMENT_SETUP_FILE = $(HOST_DIR)/environment-setup
+ENVIRONMENT_SETUP_HOST_DIR_SED_EXP = 's+$(HOST_DIR)+\$$SDK_PATH+g'
+
+define ENVIRONMENT_SETUP_INSTALL_TARGET_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_DIR_SED_EXP) $(ENVIRONMENT_SETUP_FILE)
+	printf "PS1=\"\[\e[32m\]buildroot-$(BR2_VERSION)\[\e[m\]:\[\e[34m\]\w\[\e[m\]\$$ \"\n" \
+		>> $(ENVIRONMENT_SETUP_FILE)
+endef
+
+$(eval $(generic-package))
Signature · 1 line
2.25.1
#1 lore raw

PATCH v4 2/3 package/environment-setup: add configure alias

From: Angelo Compagnucci <[email protected]>

In order to simplify the usage of a buildroot toolchain within the buildroot shell, a "configure" alias is provided to call ./configure with the correct flags.

---
 docs/manual/using-buildroot-toolchain.txt      | 4 ++--
 package/environment-setup/environment-setup    | 1 +
 package/environment-setup/environment-setup.mk | 2 ++
 3 files changed, 5 insertions(+), 2 deletions(-)
docs/manual/using-buildroot-toolchain.txt +2 -2
index 7b2de4bdfa..187ffd472b 100644
@@ -31,8 +31,8 @@ For your convenience, by selecting the package BR2_PACKAGE_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+.
+set up with the correct PATH, the complete list of +target configure
+options+ and some useful commands.
 
 Alternatively, if you just want to prepare the SDK without generating
 the tarball (e.g. because you will just be moving the +host+ directory,
package/environment-setup/environment-setup +1 -0
index b48f1979d6..db652fe090 100644
@@ -11,6 +11,7 @@ Some tips:
 * PATH is now pointing to the HOST_DIR path
 * Target configure options are already exported
 * To configure do "./configure $CONFIGURE_FLAGS"
+* Alternatively use the alias "configure"
 
 EOF
 SDK_PATH=$(dirname $(realpath "${BASH_SOURCE[0]}"))
package/environment-setup/environment-setup.mk +2 -0
index fc74594459..bd74dcb2f4 100644
@@ -21,6 +21,8 @@ define ENVIRONMENT_SETUP_INSTALL_TARGET_CMDS
 		--sysconfdir=/etc \
 		--localstatedir=/var \
 		--program-prefix=\"\n" >> $(ENVIRONMENT_SETUP_FILE)
+	printf "alias configure=\"./configure \$${CONFIGURE_FLAGS}\"\n" \
+		>> $(ENVIRONMENT_SETUP_FILE)
 	$(SED) $(ENVIRONMENT_SETUP_HOST_DIR_SED_EXP) $(ENVIRONMENT_SETUP_FILE)
 	printf "PS1=\"\[\e[32m\]buildroot-$(BR2_VERSION)\[\e[m\]:\[\e[34m\]\w\[\e[m\]\$$ \"\n" \
 		>> $(ENVIRONMENT_SETUP_FILE)
Signature · 1 line
2.25.1
#2 lore raw

PATCH v4 3/3 package/environment-setup: add cmake alias

In reply to Angelo Compagnucci

From: Angelo Compagnucci <[email protected]>

In order to simplify the usage of a buildroot toolchain within the buildroot shell, a "cmake" alias is provided to call cmake with the correct toolchain file and options.

---
 package/environment-setup/environment-setup    | 1 +
 package/environment-setup/environment-setup.mk | 3 +++
 2 files changed, 4 insertions(+)
package/environment-setup/environment-setup +1 -0
index db652fe090..7c3ddda18b 100644
@@ -12,6 +12,7 @@ Some tips:
 * Target configure options are already exported
 * To configure do "./configure $CONFIGURE_FLAGS"
 * Alternatively use the alias "configure"
+* A "cmake" alias is available
 
 EOF
 SDK_PATH=$(dirname $(realpath "${BASH_SOURCE[0]}"))
package/environment-setup/environment-setup.mk +3 -0
index bd74dcb2f4..0f3c954b65 100644
@@ -23,6 +23,9 @@ define ENVIRONMENT_SETUP_INSTALL_TARGET_CMDS
 		--program-prefix=\"\n" >> $(ENVIRONMENT_SETUP_FILE)
 	printf "alias configure=\"./configure \$${CONFIGURE_FLAGS}\"\n" \
 		>> $(ENVIRONMENT_SETUP_FILE)
+	printf "alias cmake=\"cmake \
+		-DCMAKE_TOOLCHAIN_FILE=$(HOST_DIR)/share/buildroot/toolchainfile.cmake \
+		-DCMAKE_INSTALL_PREFIX=/usr\"\n" >> $(ENVIRONMENT_SETUP_FILE)
 	$(SED) $(ENVIRONMENT_SETUP_HOST_DIR_SED_EXP) $(ENVIRONMENT_SETUP_FILE)
 	printf "PS1=\"\[\e[32m\]buildroot-$(BR2_VERSION)\[\e[m\]:\[\e[34m\]\w\[\e[m\]\$$ \"\n" \
 		>> $(ENVIRONMENT_SETUP_FILE)
Signature · 1 line
2.25.1
#3 lore raw

PATCH v4 1/3 package/environment-setup: new package

In reply to Angelo Compagnucci

Angelo, All

I have some ideas to improve the environment script.
In order to keep project/team specific customization outside of Buildroot, we can add a new configuration variable e.g. BR2_ENVIRONMENT_SETUP_FILE_SNIPPET.
We can use this to specify an external, additional file, which adds further customizations, e.g. PS1, could be others too
And right at the end of ENVIRONMENT_SETUP_INSTALL_TARGET_CMDS, add the contents of that file:

cat BR2_ENVIRONMENT_SETUP_FILE_SNIPPET >> $(ENVIRONMENT_SETUP_FILE)

If this new config value is empty, we only have the original version of the environment-setup file.

Also, I've added cleanup code(see below) to the variables inside the environment-setup script:

* take advantage of the fact that we've updated the PATH, so don't use absolute paths
* long absolute paths makes verbose builds difficult to read/follow
* use the CROSS_COMPILE variable in the definition of AR, CC, etc

This results in a more compact/readable code.

All the best,
Mircea

(quoted diff) +0 -0

b/package/environment-setup/environment-setup.mk
index fc74594459..b057c4fa34 100644

package/environment-setup/environment-setup.mk +0 -0
@@ -5,14 +5,16 @@
 

################################################################################

ENVIRONMENT_SETUP_FILE = $(HOST_DIR)/environment-setup
+ENVIRONMENT_SETUP_CROSS_COMPILE_SED_EXP = 's+$(TARGET_CROSS)+\$${CROSS_COMPILE}+g' +ENVIRONMENT_SETUP_PATH_SED_EXP = 's+$(HOST_DIR)/bin/++g'
ENVIRONMENT_SETUP_HOST_DIR_SED_EXP = 's+$(HOST_DIR)+\$$SDK_PATH+g'

define ENVIRONMENT_SETUP_INSTALL_TARGET_CMDS
cp package/environment-setup/environment-setup $(ENVIRONMENT_SETUP_FILE)
+ printf "export \"CROSS_COMPILE=$(GNU_TARGET_NAME)-\"\n" >>
$(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) \
@@ -21,7 +23,7 @@ define ENVIRONMENT_SETUP_INSTALL_TARGET_CMDS
--sysconfdir=/etc \
--localstatedir=/var \
--program-prefix=\"\n" >> $(ENVIRONMENT_SETUP_FILE)
- $(SED) $(ENVIRONMENT_SETUP_HOST_DIR_SED_EXP) $(ENVIRONMENT_SETUP_FILE)
+ $(SED) $(ENVIRONMENT_SETUP_CROSS_COMPILE_SED_EXP) -e
$(ENVIRONMENT_SETUP_PATH_SED_EXP) -e $(ENVIRONMENT_SETUP_HOST_DIR_SED_EXP) $(ENVIRONMENT_SETUP_FILE)
printf
"PS1=\"\[\e[32m\]buildroot-$(BR2_VERSION)\[\e[m\]:\[\e[34m\]\w\[\e[m\]\$$ \"\n" \
>> $(ENVIRONMENT_SETUP_FILE)
endef

#4 lore raw

PATCH v4 1/3 package/environment-setup: new package

Hi Mircea,

Il giorno lun 27 apr 2020 alle ore 18:22 Mircea GLIGA <[email protected]> ha scritto:

Quoted 12 lines

Angelo, All

I have some ideas to improve the environment script.
In order to keep project/team specific customization outside of Buildroot, we can add a new configuration variable e.g. BR2_ENVIRONMENT_SETUP_FILE_SNIPPET.
We can use this to specify an external, additional file, which adds further customizations, e.g. PS1, could be others too
And right at the end of ENVIRONMENT_SETUP_INSTALL_TARGET_CMDS, add the contents of that file:

Quoted 4 lines

cat BR2_ENVIRONMENT_SETUP_FILE_SNIPPET >> $(ENVIRONMENT_SETUP_FILE)

If this new config value is empty, we only have the original version of the environment-setup file.

I wouldn't really like to overengineer things like that. I mean, every company that needs heavy customization of this script could either generate it from scratch in a post-build script or mangling the environment-setup installed one.

This script should serve people that don't really need to know the internals and should be a simple plain good starting point.

If the PS1 thing is so bothering we can remove it, but I strongly disagree. I want to stress out that is not intended to be a fancy thing, it only serves the purpose to make it obvious that the user is not running a normal his normal shell. For this reason, I see perfectly reasonable to have a different PS1.

Quoted 51 lines

Also, I've added cleanup code(see below) to the variables inside the environment-setup script:

* take advantage of the fact that we've updated the PATH, so don't use absolute paths
* long absolute paths makes verbose builds difficult to read/follow
* use the CROSS_COMPILE variable in the definition of AR, CC, etc

This results in a more compact/readable code.

All the best,
Mircea

package/environment-setup/environment-setup.mk +1 -0
index fc74594459..b057c4fa34 100644
@@ -5,14 +5,16 @@
 
 ################################################################################
 
  ENVIRONMENT_SETUP_FILE = $(HOST_DIR)/environment-setup
+ENVIRONMENT_SETUP_CROSS_COMPILE_SED_EXP =

's+$(TARGET_CROSS)+\$${CROSS_COMPILE}+g'

package/environment-setup/environment-setup.mk +2 -0
+ENVIRONMENT_SETUP_PATH_SED_EXP = 's+$(HOST_DIR)/bin/++g'
  ENVIRONMENT_SETUP_HOST_DIR_SED_EXP = 's+$(HOST_DIR)+\$$SDK_PATH+g'
 
  define ENVIRONMENT_SETUP_INSTALL_TARGET_CMDS
        cp package/environment-setup/environment-setup $(ENVIRONMENT_SETUP_FILE)
+       printf "export \"CROSS_COMPILE=$(GNU_TARGET_NAME)-\"\n" >>

$(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) \
package/environment-setup/environment-setup.mk +1 -1
@@ -21,7 +23,7 @@ define ENVIRONMENT_SETUP_INSTALL_TARGET_CMDS
                --sysconfdir=/etc \
                --localstatedir=/var \
                --program-prefix=\"\n" >> $(ENVIRONMENT_SETUP_FILE)
-       $(SED) $(ENVIRONMENT_SETUP_HOST_DIR_SED_EXP) $(ENVIRONMENT_SETUP_FILE)
+       $(SED) $(ENVIRONMENT_SETUP_CROSS_COMPILE_SED_EXP) -e

$(ENVIRONMENT_SETUP_PATH_SED_EXP) -e $(ENVIRONMENT_SETUP_HOST_DIR_SED_EXP) $(ENVIRONMENT_SETUP_FILE)
printf
"PS1=\"\[\e[32m\]buildroot-$(BR2_VERSION)\[\e[m\]:\[\e[34m\]\w\[\e[m\]\$$

Quoted 3 lines
\"\n" \
                >> $(ENVIRONMENT_SETUP_FILE)

endef

Good suggestions, will do.

--
Profile: http://it.linkedin.com/in/compagnucciangelo

#5 lore raw

PATCH v4 1/3 package/environment-setup: new package

Hello,

Quoted 2 lines

If the PS1 thing is so bothering we can remove it, but I strongly disagree.

Please drop it. If somebody wants to change PS1, than it can be moved to a wrapper script. But keep in the environment script only the strict necessary.

Best regards,
Slydder