core/sdk: generate the SDK tarball ourselves
PATCH v3 1/1 core/sdk: generate the SDK tarball ourselves
Currently, the wording in the manual instructs the user to generate a tarball from "the contents of the +output/host+ directory".
This is pretty confusing, because taken literally, this would amount to running a command like:
tar cf my-sdk.tar -C output/host/ .
This creates a tarbomb [0], which is very bad practice, because when extracted, it creates multiple files in the current directory.
What one really wants to do, is create a tarball of the host/ directory, with something like:
tar cf my-sdk.tar -C output host/
However, this is not much better, because the top-most directory would have a very common name, host/, which is pretty easy to get conflict with when it gets extracted.
So, we fix that mess by giving the top-most directory a recognisable name, based on the target tuple, which we also use as the name of the archive (suffixed with the usual +.tar.gz+.) We offer the user the possibility to override that default by specifying the +BR2_SDK_PREFIX+ variable on the command line.
Since this is an output file, we place it in the images/ directory.
As some users expressed a very strong feeling that they do not want to generate a tarball at all, and that doing so would badly hurt their workflows [1], we actually prepare the SDK as was previously done, but under the new, intermediate rule 'prepare-sdk'. The existing 'sdk' rule obviously depend on that before generating the tarball.
We choose to make the existing rule to generate the tarball, and introduce a new rule to just prepare the SDK, rather than keep the existing rule as-is and introduce a new one to generate the tarball, because it makes sense to have the simplest rule do the correct thing, leaving advanced, power users use the longest command. If someone already had a wrapper that called 'sdk' and expected just the host directory to be prepared, then this is not broken; it just takes a bit longer (gzip is pretty fast).
Update the manual accordingly.
[0] https://en.wikipedia.org/wiki/Tar_(computing)#Tarbomb
[1] http://lists.busybox.net/pipermail/buildroot/2018-June/thread.html#223377
and some messages in the ensuing thread...
---
Changes v2 -> v3:
- drop the version from the prefix (Stefan, Thomas)
- actually have 'sdk' depend on 'prepare-sdk'
- anonymise the generated tarball
Changes v1 -> v2:
- drop the part of the manual stating this can't be re-used as a pre-built toolchain (Arnout)
- make the top-level directory and tarball name configurable (Trent, Thomas)
- change the default name (Arnout)
- allow just preparing the SDK (Stefan, Trent)
- typoes (Thomas)
--- Makefile | 15 +++++++++++++-- docs/manual/using-buildroot-toolchain.txt | 26 +++++++++++++++++--------- 2 files changed, 30 insertions(+), 11 deletions(-)
Makefile +13 -2
@@ -573,8 +573,8 @@ prepare: $(BUILD_DIR)/buildroot-config/auto.conf .PHONY: world world: target-post-image -.PHONY: sdk -sdk: world +.PHONY: prepare-sdk +prepare-sdk: world @$(call MESSAGE,"Rendering the SDK relocatable") $(TOPDIR)/support/scripts/fix-rpath host $(TOPDIR)/support/scripts/fix-rpath staging
@@ -582,6 +582,17 @@ sdk: world mkdir -p $(HOST_DIR)/share/buildroot echo $(HOST_DIR) > $(HOST_DIR)/share/buildroot/sdk-location +BR2_SDK_PREFIX ?= $(GNU_TARGET_NAME)_sdk-buildroot +.PHONY: sdk +sdk: prepare-sdk $(BR2_TAR_HOST_DEPENDENCY) + @$(call MESSAGE,"Generating SDK tarball") + $(if $(BR2_SDK_PREFIX),,$(error BR2_SDK_PREFIX can not be empty)) + $(Q)mkdir -p $(BINARIES_DIR) + $(TAR) czf "$(BINARIES_DIR)/$(BR2_SDK_PREFIX).tar.gz" \ + --owner=0 --group=0 --numeric-owner \ + --transform='s#^\.#$(BR2_SDK_PREFIX)#' \ + -C $(HOST_DIR) "." + # Populating the staging with the base directories is handled by the skeleton package $(STAGING_DIR): @mkdir -p $(STAGING_DIR)
docs/manual/using-buildroot-toolchain.txt +17 -9
@@ -12,15 +12,23 @@ The toolchain generated by Buildroot is located by default in +output/host/bin/+ to your PATH environment variable and then to use +ARCH-linux-gcc+, +ARCH-linux-objdump+, +ARCH-linux-ld+, etc. -It is possible to relocate the toolchain, this allows to distribute -the toolchain to other developers to build applications for your -target. To achieve this: +Alternatively, Buildroot can also export the toolchain and the development +files of all selected packages, as an SDK, by running the command ++make sdk+. This generates a tarball of the content of the host directory ++output/host/+, named +<TARGET-TUPLE>_sdk-buildroot.tar.gz+ (which can be +overriden by setting the environment variable +BR2_SDK_PREFIX+) and +located in the output directory +output/images/+. -* run +make sdk+, which prepares the toolchain to be relocatable; -* tarball the contents of the +output/host+ directory; -* distribute the resulting tarball. +This tarball can then be distributed to application developers, when +they want to develop their applications that are not (yet) packaged as +a Buildroot package. -Once the toolchain is installed to the new location, the user must run -the +relocate-sdk.sh+ script to make sure all paths are updated with -the new location. +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. +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 +you to just prepare the SDK with +make prepare-sdk+ without actually +generating a tarball.
Signature · 1 line
2.14.1
PATCH v3 1/1 core/sdk: generate the SDK tarball ourselves
Hi Yann, All,
looks OK to me.
Quoted 150 lines · Yann E. MORIN
Currently, the wording in the manual instructs the user to generate a tarball from "the contents of the +output/host+ directory".
This is pretty confusing, because taken literally, this would amount to running a command like:
tar cf my-sdk.tar -C output/host/ .
This creates a tarbomb [0], which is very bad practice, because when extracted, it creates multiple files in the current directory.
What one really wants to do, is create a tarball of the host/ directory, with something like:
tar cf my-sdk.tar -C output host/
However, this is not much better, because the top-most directory would have a very common name, host/, which is pretty easy to get conflict with when it gets extracted.
So, we fix that mess by giving the top-most directory a recognisable name, based on the target tuple, which we also use as the name of the archive (suffixed with the usual +.tar.gz+.) We offer the user the possibility to override that default by specifying the +BR2_SDK_PREFIX+ variable on the command line.
Since this is an output file, we place it in the images/ directory.
As some users expressed a very strong feeling that they do not want to generate a tarball at all, and that doing so would badly hurt their workflows [1], we actually prepare the SDK as was previously done, but under the new, intermediate rule 'prepare-sdk'. The existing 'sdk' rule obviously depend on that before generating the tarball.
We choose to make the existing rule to generate the tarball, and introduce a new rule to just prepare the SDK, rather than keep the existing rule as-is and introduce a new one to generate the tarball, because it makes sense to have the simplest rule do the correct thing, leaving advanced, power users use the longest command. If someone already had a wrapper that called 'sdk' and expected just the host directory to be prepared, then this is not broken; it just takes a bit longer (gzip is pretty fast).
Update the manual accordingly.
[0] https://en.wikipedia.org/wiki/Tar_(computing)#Tarbomb
[1]
http://lists.busybox.net/pipermail/buildroot/2018-June/thread.html#223377
and some messages in the ensuing thread...Signed-off-by "Yann E. MORIN" <[email protected]>Cc Wolfgang Grandegger <[email protected]>Cc Thomas Petazzoni <[email protected]>Cc Arnout Vandecappelle <[email protected]>Cc Stefan Becker <[email protected]>Cc Trent Piepho <[email protected]>---
Changes v2 -> v3:
- drop the version from the prefix (Stefan, Thomas)
- actually have 'sdk' depend on 'prepare-sdk'
- anonymise the generated tarballChanges v1 -> v2:
- drop the part of the manual stating this can't be re-used as a pre-built toolchain (Arnout)
- make the top-level directory and tarball name configurable (Trent, Thomas)
- change the default name (Arnout)
- allow just preparing the SDK (Stefan, Trent)
- typoes (Thomas)--- Makefile | 15 +++++++++++++-- docs/manual/using-buildroot-toolchain.txt | 26 +++++++++++++++++--------- 2 files changed, 30 insertions(+), 11 deletions(-)Makefile +13
-2@@ -573,8 +573,8 @@ prepare: $(BUILD_DIR)/buildroot-config/auto.conf .PHONY: world world: target-post-image -.PHONY: sdk -sdk: world +.PHONY: prepare-sdk +prepare-sdk: world @$(call MESSAGE,"Rendering the SDK relocatable") $(TOPDIR)/support/scripts/fix-rpath host $(TOPDIR)/support/scripts/fix-rpath staging@@ -582,6 +582,17 @@ sdk: world mkdir -p $(HOST_DIR)/share/buildroot echo $(HOST_DIR) > $(HOST_DIR)/share/buildroot/sdk-location +BR2_SDK_PREFIX ?= $(GNU_TARGET_NAME)_sdk-buildroot +.PHONY: sdk +sdk: prepare-sdk $(BR2_TAR_HOST_DEPENDENCY) + @$(call MESSAGE,"Generating SDK tarball") + $(if $(BR2_SDK_PREFIX),,$(error BR2_SDK_PREFIX can not be empty)) + $(Q)mkdir -p $(BINARIES_DIR) + $(TAR) czf "$(BINARIES_DIR)/$(BR2_SDK_PREFIX).tar.gz" \ + --owner=0 --group=0 --numeric-owner \ + --transform='s#^\.#$(BR2_SDK_PREFIX)#' \ + -C $(HOST_DIR) "." + # Populating the staging with the base directories is handled by theskeleton package
$(STAGING_DIR):@mkdir -p $(STAGING_DIR)docs/manual/using-buildroot-toolchain.txt +0
-0@@ -12,15 +12,23 @@ The toolchain generated by Buildroot is located bydefault in
+output/host/bin/+ to your PATH environment variable and then to use +ARCH-linux-gcc+, +ARCH-linux-objdump+, +ARCH-linux-ld+, etc.docs/manual/using-buildroot-toolchain.txt +17
-10-It is possible to relocate the toolchain, this allows to distribute -the toolchain to other developers to build applications for your -target. To achieve this: +Alternatively, Buildroot can also export the toolchain and the development +files of all selected packages, as an SDK, by running the command ++make sdk+. This generates a tarball of the content of the host directory ++output/host/+, named +<TARGET-TUPLE>_sdk-buildroot.tar.gz+ (which can be +overriden by setting the environment variable +BR2_SDK_PREFIX+) and +located in the output directory +output/images/+. -* run +make sdk+, which prepares the toolchain to be relocatable; -* tarball the contents of the +output/host+ directory; -* distribute the resulting tarball. +This tarball can then be distributed to application developers, when +they want to develop their applications that are not (yet) packaged as +a Buildroot package. -Once the toolchain is installed to the new location, the user must run -the +relocate-sdk.sh+ script to make sure all paths are updated with -the new location. +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. +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 +you to just prepare the SDK with +make prepare-sdk+ without actually +generating a tarball. --
Quoted 3 lines
2.14.1
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.busybox.net/pipermail/buildroot/attachments/20180805/525a7d2c/attachment.html>
PATCH v3 1/1 core/sdk: generate the SDK tarball ourselves
Stefan, All,
On 2018-08-05 16:04 +0300, Stefan Becker spake thusly:
Quoted 2 lines
Hi Yann, All,
looks OK to me.
Thanks! :-)
Is that an equivalent to a formal 'Reviewed-by' tag? ;-)
https://buildroot.org/downloads/manual/manual.html#_reviewing_and_testing_patches
Regards,
Yann E. MORIN.
Quoted 161 lines · Yann E. MORIN
Currently, the wording in the manual instructs the user to generate a tarball from "the contents of the +output/host+ directory".
This is pretty confusing, because taken literally, this would amount to running a command like:
? ? tar cf my-sdk.tar -C output/host/ .
This creates a tarbomb [0], which is very bad practice, because when extracted, it creates multiple files in the current directory.
What one really wants to do, is create a tarball of the host/ directory, with something like:
? ? tar cf my-sdk.tar -C output host/
However, this is not much better, because the top-most directory would have a very common name, host/, which is pretty easy to get conflict with when it gets extracted.
So, we fix that mess by giving the top-most directory a recognisable name, based on the target tuple, which we also use as the name of the archive (suffixed with the usual +.tar.gz+.) We offer the user the possibility to override that default by specifying the +BR2_SDK_PREFIX+ variable on the command line.
Since this is an output file, we place it in the images/ directory.
As some users expressed a very strong feeling that they do not want to generate a tarball at all, and that doing so would badly hurt their workflows [1], we actually prepare the SDK as was previously done, but under the new, intermediate rule 'prepare-sdk'. The existing 'sdk' rule obviously depend on that before generating the tarball.
We choose to make the existing rule to generate the tarball, and introduce a new rule to just prepare the SDK, rather than keep the existing rule as-is and introduce a new one to generate the tarball, because it makes sense to have the simplest rule do the correct thing, leaving advanced, power users use the longest command. If someone already had a wrapper that called 'sdk' and expected just the host directory to be prepared, then this is not broken; it just takes a bit longer (gzip is pretty fast).
Update the manual accordingly.
[0] [2]https://en.wikipedia.org/wiki/Tar_(computing)#Tarbomb
[1] [3]http://lists.busybox.net/pipermail/buildroot/2018-June/thread.html#223377 ? ? and some messages in the ensuing thread...Signed-off-by "Yann E. MORIN" < [4][email protected]>Cc Wolfgang Grandegger < [5][email protected]>Cc Thomas Petazzoni < [6][email protected]>Cc Arnout Vandecappelle < [7][email protected]>Cc Stefan Becker < [8][email protected]>Cc Trent Piepho < [9][email protected]>---
Changes v2 -> v3:
? - drop the version from the prefix? (Stefan, Thomas) ? - actually have 'sdk' depend on 'prepare-sdk' ? - anonymise the generated tarballChanges v1 -> v2:
? - drop the part of the manual stating this can't be re-used as a ? ? pre-built toolchain? (Arnout)
? - make the top-level directory and tarball name configurable ? ? (Trent, Thomas)
? - change the default name? (Arnout)
? - allow just preparing the SDK (Stefan, Trent)
? - typoes? (Thomas)
---
?Makefile? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ?? | 15 +++++++++++++-- ?docs/manual/using-buildroot-toolchain.txt | 26 +++++++++++++++++---------?2 files changed, 30 insertions(+), 11 deletions(-)
diff --git a/Makefile b/Makefile index 37c7072c7c..e13e5eaefa 100644 --- a/Makefile +++ b/Makefile @@ -573,8 +573,8 @@ prepare: $(BUILD_DIR)/buildroot-config/auto.conf ?.PHONY: world ?world: target-post-image -.PHONY: sdk -sdk: world +.PHONY: prepare-sdk +prepare-sdk: world ? ? ? ? @$(call MESSAGE,"Rendering the SDK relocatable") ? ? ? ? $(TOPDIR)/support/scripts/fix-rpath host ? ? ? ? $(TOPDIR)/support/scripts/fix-rpath staging @@ -582,6 +582,17 @@ sdk: world ? ? ? ? mkdir -p $(HOST_DIR)/share/buildroot ? ? ? ? echo $(HOST_DIR) > $(HOST_DIR)/share/buildroot/sdk-location +BR2_SDK_PREFIX ?= $(GNU_TARGET_NAME)_sdk-buildroot +.PHONY: sdk +sdk: prepare-sdk $(BR2_TAR_HOST_DEPENDENCY) +? ? ? ?@$(call MESSAGE,"Generating SDK tarball") +? ? ? ?$(if $(BR2_SDK_PREFIX),,$(error BR2_SDK_PREFIX can not be empty)) +? ? ? ?$(Q)mkdir -p $(BINARIES_DIR) +? ? ? ?$(TAR) czf "$(BINARIES_DIR)/$(BR2_SDK_PREFIX).tar.gz" \ +? ? ? ? ? ? ? ?--owner=0 --group=0 --numeric-owner \ +? ? ? ? ? ? ? ?--transform='s#^\.#$(BR2_SDK_PREFIX)#' \ +? ? ? ? ? ? ? ?-C $(HOST_DIR) "." + ?# Populating the staging with the base directories is handled by the skeleton package ?$(STAGING_DIR): ? ? ? ? @mkdir -p $(STAGING_DIR) diff --git a/docs/manual/using-buildroot-toolchain.txt b/docs/manual/using-buildroot-toolchain.txt index 3246dc2411..0c0c35fced 100644 --- a/docs/manual/using-buildroot-toolchain.txt +++ b/docs/manual/using-buildroot-toolchain.txt @@ -12,15 +12,23 @@ The toolchain generated by Buildroot is located by default in ?+output/host/bin/+ to your PATH environment variable and then to ?use +ARCH-linux-gcc+, +ARCH-linux-objdump+, +ARCH-linux-ld+, etc.-It is possible to relocate the toolchain, this allows to distribute -the toolchain to other developers to build applications for your -target. To achieve this:
+Alternatively, Buildroot can also export the toolchain and the development +files of all selected packages, as an SDK, by running the command ++make sdk+. This generates a tarball of the content of the host directory ++output/host/+, named +<TARGET-TUPLE>_sdk-buildroot.tar.gz+ (which can be +overriden by setting the environment variable +BR2_SDK_PREFIX+) and +located in the output directory +output/images/+.-* run +make sdk+, which prepares the toolchain to be relocatable; -* tarball the contents of the +output/host+ directory;
-* distribute the resulting tarball.
+This tarball can then be distributed to application developers, when +they want to develop their applications that are not (yet) packaged as +a Buildroot package.-Once the toolchain is installed to the new location, the user must run -the +relocate-sdk.sh+ script to make sure all paths are updated with -the new location.
+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.+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 +you to just prepare the SDK with +make prepare-sdk+ without actually +generating a tarball.
--
2.14.1Links:
1. mailto:yann.morin.1998 at free.fr
2. https://en.wikipedia.org/wiki/Tar_(computing)#Tarbomb
3. http://lists.busybox.net/pipermail/buildroot/2018-June/thread.html#223377
4. mailto:yann.morin.1998 at free.fr
5. mailto:wg at grandegger.com
6. mailto:thomas.petazzoni at bootlin.com
7. mailto:arnout at mind.be
8. mailto:chemobejk at gmail.com
9. mailto:tpiepho at impinj.com
Signature · 6 lines
.-----------------.--------------------.------------------.--------------------. | Yann E. MORIN | Real-Time Embedded | /"\ ASCII RIBBON | Erics' conspiracy: | | +33 662 376 056 | Software Designer | \ / CAMPAIGN | ___ | | +33 223 225 172 `------------.-------: X AGAINST | \e/ There is no | | http://ymorin.is-a-geek.org/ | _/*\_ | / \ HTML MAIL | v conspiracy. | '------------------------------^-------^------------------^--------------------'
PATCH v3 1/1 core/sdk: generate the SDK tarball ourselves
In reply to Yann E. MORINNo time to test this though...
Quoted 150 lines · Yann E. MORIN
Currently, the wording in the manual instructs the user to generate a tarball from "the contents of the +output/host+ directory".
This is pretty confusing, because taken literally, this would amount to running a command like:
tar cf my-sdk.tar -C output/host/ .
This creates a tarbomb [0], which is very bad practice, because when extracted, it creates multiple files in the current directory.
What one really wants to do, is create a tarball of the host/ directory, with something like:
tar cf my-sdk.tar -C output host/
However, this is not much better, because the top-most directory would have a very common name, host/, which is pretty easy to get conflict with when it gets extracted.
So, we fix that mess by giving the top-most directory a recognisable name, based on the target tuple, which we also use as the name of the archive (suffixed with the usual +.tar.gz+.) We offer the user the possibility to override that default by specifying the +BR2_SDK_PREFIX+ variable on the command line.
Since this is an output file, we place it in the images/ directory.
As some users expressed a very strong feeling that they do not want to generate a tarball at all, and that doing so would badly hurt their workflows [1], we actually prepare the SDK as was previously done, but under the new, intermediate rule 'prepare-sdk'. The existing 'sdk' rule obviously depend on that before generating the tarball.
We choose to make the existing rule to generate the tarball, and introduce a new rule to just prepare the SDK, rather than keep the existing rule as-is and introduce a new one to generate the tarball, because it makes sense to have the simplest rule do the correct thing, leaving advanced, power users use the longest command. If someone already had a wrapper that called 'sdk' and expected just the host directory to be prepared, then this is not broken; it just takes a bit longer (gzip is pretty fast).
Update the manual accordingly.
[0] https://en.wikipedia.org/wiki/Tar_(computing)#Tarbomb
[1]
http://lists.busybox.net/pipermail/buildroot/2018-June/thread.html#223377
and some messages in the ensuing thread...Signed-off-by "Yann E. MORIN" <[email protected]>Cc Wolfgang Grandegger <[email protected]>Cc Thomas Petazzoni <[email protected]>Cc Arnout Vandecappelle <[email protected]>Cc Stefan Becker <[email protected]>Cc Trent Piepho <[email protected]>---
Changes v2 -> v3:
- drop the version from the prefix (Stefan, Thomas)
- actually have 'sdk' depend on 'prepare-sdk'
- anonymise the generated tarballChanges v1 -> v2:
- drop the part of the manual stating this can't be re-used as a pre-built toolchain (Arnout)
- make the top-level directory and tarball name configurable (Trent, Thomas)
- change the default name (Arnout)
- allow just preparing the SDK (Stefan, Trent)
- typoes (Thomas)--- Makefile | 15 +++++++++++++-- docs/manual/using-buildroot-toolchain.txt | 26 +++++++++++++++++--------- 2 files changed, 30 insertions(+), 11 deletions(-)Makefile +13
-2@@ -573,8 +573,8 @@ prepare: $(BUILD_DIR)/buildroot-config/auto.conf .PHONY: world world: target-post-image -.PHONY: sdk -sdk: world +.PHONY: prepare-sdk +prepare-sdk: world @$(call MESSAGE,"Rendering the SDK relocatable") $(TOPDIR)/support/scripts/fix-rpath host $(TOPDIR)/support/scripts/fix-rpath staging@@ -582,6 +582,17 @@ sdk: world mkdir -p $(HOST_DIR)/share/buildroot echo $(HOST_DIR) > $(HOST_DIR)/share/buildroot/sdk-location +BR2_SDK_PREFIX ?= $(GNU_TARGET_NAME)_sdk-buildroot +.PHONY: sdk +sdk: prepare-sdk $(BR2_TAR_HOST_DEPENDENCY) + @$(call MESSAGE,"Generating SDK tarball") + $(if $(BR2_SDK_PREFIX),,$(error BR2_SDK_PREFIX can not be empty)) + $(Q)mkdir -p $(BINARIES_DIR) + $(TAR) czf "$(BINARIES_DIR)/$(BR2_SDK_PREFIX).tar.gz" \ + --owner=0 --group=0 --numeric-owner \ + --transform='s#^\.#$(BR2_SDK_PREFIX)#' \ + -C $(HOST_DIR) "." + # Populating the staging with the base directories is handled by theskeleton package
$(STAGING_DIR):@mkdir -p $(STAGING_DIR)docs/manual/using-buildroot-toolchain.txt +0
-0@@ -12,15 +12,23 @@ The toolchain generated by Buildroot is located bydefault in
+output/host/bin/+ to your PATH environment variable and then to use +ARCH-linux-gcc+, +ARCH-linux-objdump+, +ARCH-linux-ld+, etc.docs/manual/using-buildroot-toolchain.txt +17
-10-It is possible to relocate the toolchain, this allows to distribute -the toolchain to other developers to build applications for your -target. To achieve this: +Alternatively, Buildroot can also export the toolchain and the development +files of all selected packages, as an SDK, by running the command ++make sdk+. This generates a tarball of the content of the host directory ++output/host/+, named +<TARGET-TUPLE>_sdk-buildroot.tar.gz+ (which can be +overriden by setting the environment variable +BR2_SDK_PREFIX+) and +located in the output directory +output/images/+. -* run +make sdk+, which prepares the toolchain to be relocatable; -* tarball the contents of the +output/host+ directory; -* distribute the resulting tarball. +This tarball can then be distributed to application developers, when +they want to develop their applications that are not (yet) packaged as +a Buildroot package. -Once the toolchain is installed to the new location, the user must run -the +relocate-sdk.sh+ script to make sure all paths are updated with -the new location. +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. +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 +you to just prepare the SDK with +make prepare-sdk+ without actually +generating a tarball. --
Quoted 3 lines
2.14.1
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.busybox.net/pipermail/buildroot/attachments/20180805/e2bdc2e5/attachment.html>
PATCH v3 1/1 core/sdk: generate the SDK tarball ourselves
Stefan All,
On 2018-08-05 16:20 +0300, Stefan Becker spake thusly:
Quoted 2 lines
Reviewed-by Stefan Becker < [1][email protected]>No time to test this though...
No problem. Thanks! :-)
Regards,
Yann E. MORIN.
Quoted 167 lines · Yann E. MORIN
Currently, the wording in the manual instructs the user to generate a tarball from "the contents of the +output/host+ directory".
This is pretty confusing, because taken literally, this would amount to running a command like:
? ? tar cf my-sdk.tar -C output/host/ .
This creates a tarbomb [0], which is very bad practice, because when extracted, it creates multiple files in the current directory.
What one really wants to do, is create a tarball of the host/ directory, with something like:
? ? tar cf my-sdk.tar -C output host/
However, this is not much better, because the top-most directory would have a very common name, host/, which is pretty easy to get conflict with when it gets extracted.
So, we fix that mess by giving the top-most directory a recognisable name, based on the target tuple, which we also use as the name of the archive (suffixed with the usual +.tar.gz+.) We offer the user the possibility to override that default by specifying the +BR2_SDK_PREFIX+ variable on the command line.
Since this is an output file, we place it in the images/ directory.
As some users expressed a very strong feeling that they do not want to generate a tarball at all, and that doing so would badly hurt their workflows [1], we actually prepare the SDK as was previously done, but under the new, intermediate rule 'prepare-sdk'. The existing 'sdk' rule obviously depend on that before generating the tarball.
We choose to make the existing rule to generate the tarball, and introduce a new rule to just prepare the SDK, rather than keep the existing rule as-is and introduce a new one to generate the tarball, because it makes sense to have the simplest rule do the correct thing, leaving advanced, power users use the longest command. If someone already had a wrapper that called 'sdk' and expected just the host directory to be prepared, then this is not broken; it just takes a bit longer (gzip is pretty fast).
Update the manual accordingly.
[0] [3]https://en.wikipedia.org/wiki/Tar_(computing)#Tarbomb
[1] [4]http://lists.busybox.net/pipermail/buildroot/2018-June/thread.html#223377 ? ? and some messages in the ensuing thread...Signed-off-by "Yann E. MORIN" < [5][email protected]>Cc Wolfgang Grandegger < [6][email protected]>Cc Thomas Petazzoni < [7][email protected]>Cc Arnout Vandecappelle < [8][email protected]>Cc Stefan Becker < [9][email protected]>Cc Trent Piepho < [10][email protected]>---
Changes v2 -> v3:
? - drop the version from the prefix? (Stefan, Thomas) ? - actually have 'sdk' depend on 'prepare-sdk' ? - anonymise the generated tarballChanges v1 -> v2:
? - drop the part of the manual stating this can't be re-used as a ? ? pre-built toolchain? (Arnout)
? - make the top-level directory and tarball name configurable ? ? (Trent, Thomas)
? - change the default name? (Arnout)
? - allow just preparing the SDK (Stefan, Trent)
? - typoes? (Thomas)
---
?Makefile? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ?? | 15 +++++++++++++-- ?docs/manual/using-buildroot-toolchain.txt | 26 +++++++++++++++++---------?2 files changed, 30 insertions(+), 11 deletions(-)
diff --git a/Makefile b/Makefile index 37c7072c7c..e13e5eaefa 100644 --- a/Makefile +++ b/Makefile @@ -573,8 +573,8 @@ prepare: $(BUILD_DIR)/buildroot-config/auto.conf ?.PHONY: world ?world: target-post-image -.PHONY: sdk -sdk: world +.PHONY: prepare-sdk +prepare-sdk: world ? ? ? ? @$(call MESSAGE,"Rendering the SDK relocatable") ? ? ? ? $(TOPDIR)/support/scripts/fix-rpath host ? ? ? ? $(TOPDIR)/support/scripts/fix-rpath staging @@ -582,6 +582,17 @@ sdk: world ? ? ? ? mkdir -p $(HOST_DIR)/share/buildroot ? ? ? ? echo $(HOST_DIR) > $(HOST_DIR)/share/buildroot/sdk-location +BR2_SDK_PREFIX ?= $(GNU_TARGET_NAME)_sdk-buildroot +.PHONY: sdk +sdk: prepare-sdk $(BR2_TAR_HOST_DEPENDENCY) +? ? ? ?@$(call MESSAGE,"Generating SDK tarball") +? ? ? ?$(if $(BR2_SDK_PREFIX),,$(error BR2_SDK_PREFIX can not be empty)) +? ? ? ?$(Q)mkdir -p $(BINARIES_DIR) +? ? ? ?$(TAR) czf "$(BINARIES_DIR)/$(BR2_SDK_PREFIX).tar.gz" \ +? ? ? ? ? ? ? ?--owner=0 --group=0 --numeric-owner \ +? ? ? ? ? ? ? ?--transform='s#^\.#$(BR2_SDK_PREFIX)#' \ +? ? ? ? ? ? ? ?-C $(HOST_DIR) "." + ?# Populating the staging with the base directories is handled by the skeleton package ?$(STAGING_DIR): ? ? ? ? @mkdir -p $(STAGING_DIR) diff --git a/docs/manual/using-buildroot-toolchain.txt b/docs/manual/using-buildroot-toolchain.txt index 3246dc2411..0c0c35fced 100644 --- a/docs/manual/using-buildroot-toolchain.txt +++ b/docs/manual/using-buildroot-toolchain.txt @@ -12,15 +12,23 @@ The toolchain generated by Buildroot is located by default in ?+output/host/bin/+ to your PATH environment variable and then to ?use +ARCH-linux-gcc+, +ARCH-linux-objdump+, +ARCH-linux-ld+, etc.-It is possible to relocate the toolchain, this allows to distribute -the toolchain to other developers to build applications for your -target. To achieve this:
+Alternatively, Buildroot can also export the toolchain and the development +files of all selected packages, as an SDK, by running the command ++make sdk+. This generates a tarball of the content of the host directory ++output/host/+, named +<TARGET-TUPLE>_sdk-buildroot.tar.gz+ (which can be +overriden by setting the environment variable +BR2_SDK_PREFIX+) and +located in the output directory +output/images/+.-* run +make sdk+, which prepares the toolchain to be relocatable; -* tarball the contents of the +output/host+ directory;
-* distribute the resulting tarball.
+This tarball can then be distributed to application developers, when +they want to develop their applications that are not (yet) packaged as +a Buildroot package.-Once the toolchain is installed to the new location, the user must run -the +relocate-sdk.sh+ script to make sure all paths are updated with -the new location.
+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.+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 +you to just prepare the SDK with +make prepare-sdk+ without actually +generating a tarball.
--
2.14.1Links:
1. mailto:chemobejk at gmail.com
2. mailto:yann.morin.1998 at free.fr
3. https://en.wikipedia.org/wiki/Tar_(computing)#Tarbomb
4. http://lists.busybox.net/pipermail/buildroot/2018-June/thread.html#223377
5. mailto:yann.morin.1998 at free.fr
6. mailto:wg at grandegger.com
7. mailto:thomas.petazzoni at bootlin.com
8. mailto:arnout at mind.be
9. mailto:chemobejk at gmail.com
10. mailto:tpiepho at impinj.com_______________________________________________
buildroot mailing list
buildroot at busybox.net
http://lists.busybox.net/mailman/listinfo/buildroot
Signature · 6 lines
.-----------------.--------------------.------------------.--------------------. | Yann E. MORIN | Real-Time Embedded | /"\ ASCII RIBBON | Erics' conspiracy: | | +33 662 376 056 | Software Designer | \ / CAMPAIGN | ___ | | +33 223 225 172 `------------.-------: X AGAINST | \e/ There is no | | http://ymorin.is-a-geek.org/ | _/*\_ | / \ HTML MAIL | v conspiracy. | '------------------------------^-------^------------------^--------------------'
Thomas Petazzoni
AppliedPATCH v3 1/1 core/sdk: generate the SDK tarball ourselves
In reply to Yann E. MORINHello,
Quoted 56 lines · Yann E. MORIN
Currently, the wording in the manual instructs the user to generate a tarball from "the contents of the +output/host+ directory".
This is pretty confusing, because taken literally, this would amount to running a command like:
tar cf my-sdk.tar -C output/host/ .
This creates a tarbomb [0], which is very bad practice, because when extracted, it creates multiple files in the current directory.
What one really wants to do, is create a tarball of the host/ directory, with something like:
tar cf my-sdk.tar -C output host/
However, this is not much better, because the top-most directory would have a very common name, host/, which is pretty easy to get conflict with when it gets extracted.
So, we fix that mess by giving the top-most directory a recognisable name, based on the target tuple, which we also use as the name of the archive (suffixed with the usual +.tar.gz+.) We offer the user the possibility to override that default by specifying the +BR2_SDK_PREFIX+ variable on the command line.
Since this is an output file, we place it in the images/ directory.
As some users expressed a very strong feeling that they do not want to generate a tarball at all, and that doing so would badly hurt their workflows [1], we actually prepare the SDK as was previously done, but under the new, intermediate rule 'prepare-sdk'. The existing 'sdk' rule obviously depend on that before generating the tarball.
We choose to make the existing rule to generate the tarball, and introduce a new rule to just prepare the SDK, rather than keep the existing rule as-is and introduce a new one to generate the tarball, because it makes sense to have the simplest rule do the correct thing, leaving advanced, power users use the longest command. If someone already had a wrapper that called 'sdk' and expected just the host directory to be prepared, then this is not broken; it just takes a bit longer (gzip is pretty fast).
Update the manual accordingly.
[0] https://en.wikipedia.org/wiki/Tar_(computing)#Tarbomb
[1] http://lists.busybox.net/pipermail/buildroot/2018-June/thread.html#223377
and some messages in the ensuing thread...Signed-off-by "Yann E. MORIN" <[email protected]>Cc Wolfgang Grandegger <[email protected]>Cc Thomas Petazzoni <[email protected]>Cc Arnout Vandecappelle <[email protected]>Cc Stefan Becker <[email protected]>Cc Trent Piepho <[email protected]>
Quoted 5 lines
---
Changes v2 -> v3:
- drop the version from the prefix (Stefan, Thomas)
- actually have 'sdk' depend on 'prepare-sdk'
- anonymise the generated tarball
Applied to next, thanks!
Thomas
Signature · 3 lines
Thomas Petazzoni, CTO, Bootlin (formerly Free Electrons) Embedded Linux and Kernel engineering https://bootlin.com