* [Buildroot] [PATCH 2/4] pkg-infra: introduce pre/post-step hooks
2013-10-27 17:24 ` [Buildroot] [PATCH 1/4] post-{build, images} hooks: export BUILD_DIR too Yann E. MORIN
@ 2013-10-27 17:24 ` Yann E. MORIN
2013-10-27 21:40 ` Thomas De Schampheleire
2013-10-27 17:24 ` [Buildroot] [PATCH 3/4] pkg-infra: add hook to log timing of steps Yann E. MORIN
` (2 subsequent siblings)
3 siblings, 1 reply; 20+ messages in thread
From: Yann E. MORIN @ 2013-10-27 17:24 UTC (permalink / raw)
To: buildroot
From: "Yann E. MORIN" <yann.morin.1998@free.fr>
This hooks will let us instrument the build process in many ways:
- log current step to see what broke
- time each step to see what is worth optimising
- sanity-check installed files (rpath, overwritten files...)
- call user-provided script
- ...
The steps are coarse-grain, and all have a 'start' and a 'end' hooks.
Here is the list of available steps (8 total):
- extract
- patch
- configure
- build
- install-host
- install-staging
- install-image
- install-target
The download, clean and uninstall steps are not instrumented on purpose.
Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
---
package/pkg-generic.mk | 39 +++++++++++++++++++++++++++++++++++++++
1 file changed, 39 insertions(+)
diff --git a/package/pkg-generic.mk b/package/pkg-generic.mk
index 4bba4b5..799555c 100644
--- a/package/pkg-generic.mk
+++ b/package/pkg-generic.mk
@@ -21,6 +21,29 @@
################################################################################
################################################################################
+# Helper functions to catch start/end of each steps
+################################################################################
+
+# Those two functions are called by each steps below.
+# They are responsible for calling all hooks defined in $(STEP_HOOKS)
+# and pass each of them two arguments:
+# $1: either 'start' or 'end'
+# $2: the name of the step
+# $3: the name of the package
+
+# Start step
+# $1: step name
+define step_start
+ $(foreach hook,$(STEP_HOOKS),$(call $(hook),start,$(1),$($(PKG)_NAME))$(sep))
+endef
+
+# End step
+# $1: step name
+define step_end
+ $(foreach hook,$(STEP_HOOKS),$(call $(hook),end,$(1),$($(PKG)_NAME))$(sep))
+endef
+
+################################################################################
# Implicit targets -- produce a stamp file for each step of a package build
################################################################################
@@ -55,6 +78,7 @@ endif
# Unpack the archive
$(BUILD_DIR)/%/.stamp_extracted:
+ @$(call step_start,extract)
@$(call MESSAGE,"Extracting")
$(Q)mkdir -p $(@D)
$($(PKG)_EXTRACT_CMDS)
@@ -62,6 +86,7 @@ $(BUILD_DIR)/%/.stamp_extracted:
$(Q)chmod -R +rw $(@D)
$(foreach hook,$($(PKG)_POST_EXTRACT_HOOKS),$(call $(hook))$(sep))
$(Q)touch $@
+ @$(call step_end,extract)
# Rsync the source directory if the <pkg>_OVERRIDE_SRCDIR feature is
# used.
@@ -90,6 +115,7 @@ endif
$(BUILD_DIR)/%/.stamp_patched: NAMEVER = $(RAWNAME)-$($(PKG)_VERSION)
$(BUILD_DIR)/%/.stamp_patched: PATCH_BASE_DIRS = $($(PKG)_DIR_PREFIX)/$(RAWNAME) $(call qstrip,$(BR2_GLOBAL_PATCH_DIR))/$(RAWNAME)
$(BUILD_DIR)/%/.stamp_patched:
+ @$(call step_start,patch)
@$(call MESSAGE,"Patching $($(PKG)_DIR_PREFIX)/$(RAWNAME)")
$(foreach hook,$($(PKG)_PRE_PATCH_HOOKS),$(call $(hook))$(sep))
$(foreach p,$($(PKG)_PATCH),support/scripts/apply-patches.sh $(@D) $(DL_DIR) $(notdir $(p))$(sep))
@@ -106,31 +132,39 @@ $(BUILD_DIR)/%/.stamp_patched:
)
$(foreach hook,$($(PKG)_POST_PATCH_HOOKS),$(call $(hook))$(sep))
$(Q)touch $@
+ @$(call step_end,patch)
# Configure
$(BUILD_DIR)/%/.stamp_configured:
+ @$(call step_start,configure)
$(foreach hook,$($(PKG)_PRE_CONFIGURE_HOOKS),$(call $(hook))$(sep))
@$(call MESSAGE,"Configuring")
$($(PKG)_CONFIGURE_CMDS)
$(foreach hook,$($(PKG)_POST_CONFIGURE_HOOKS),$(call $(hook))$(sep))
$(Q)touch $@
+ @$(call step_end,configure)
# Build
$(BUILD_DIR)/%/.stamp_built::
+ @$(call step_start,build)
@$(call MESSAGE,"Building")
$($(PKG)_BUILD_CMDS)
$(foreach hook,$($(PKG)_POST_BUILD_HOOKS),$(call $(hook))$(sep))
$(Q)touch $@
+ @$(call step_end,build)
# Install to host dir
$(BUILD_DIR)/%/.stamp_host_installed:
+ @$(call step_start,install-host)
@$(call MESSAGE,"Installing to host directory")
$($(PKG)_INSTALL_CMDS)
$(foreach hook,$($(PKG)_POST_INSTALL_HOOKS),$(call $(hook))$(sep))
$(Q)touch $@
+ @$(call step_end,install-host)
# Install to staging dir
$(BUILD_DIR)/%/.stamp_staging_installed:
+ @$(call step_start,install-staging)
@$(call MESSAGE,"Installing to staging directory")
$($(PKG)_INSTALL_STAGING_CMDS)
$(foreach hook,$($(PKG)_POST_INSTALL_STAGING_HOOKS),$(call $(hook))$(sep))
@@ -142,16 +176,20 @@ $(BUILD_DIR)/%/.stamp_staging_installed:
$(addprefix $(STAGING_DIR)/usr/bin/,$($(PKG)_CONFIG_SCRIPTS)) ;\
fi
$(Q)touch $@
+ @$(call step_end,install-staging)
# Install to images dir
$(BUILD_DIR)/%/.stamp_images_installed:
+ @$(call step_start,install-image)
@$(call MESSAGE,"Installing to images directory")
$($(PKG)_INSTALL_IMAGES_CMDS)
$(foreach hook,$($(PKG)_POST_INSTALL_IMAGES_HOOKS),$(call $(hook))$(sep))
$(Q)touch $@
+ @$(call step_end,install-image)
# Install to target dir
$(BUILD_DIR)/%/.stamp_target_installed:
+ @$(call step_start,install-target)
@$(call MESSAGE,"Installing to target")
$(if $(BR2_INIT_SYSTEMD),\
$($(PKG)_INSTALL_INIT_SYSTEMD))
@@ -163,6 +201,7 @@ $(BUILD_DIR)/%/.stamp_target_installed:
$(RM) -f $(addprefix $(TARGET_DIR)/usr/bin/,$($(PKG)_CONFIG_SCRIPTS)) ; \
fi
$(Q)touch $@
+ @$(call step_end,install-target)
# Clean package
$(BUILD_DIR)/%/.stamp_cleaned:
--
1.8.1.2
^ permalink raw reply related [flat|nested] 20+ messages in thread* [Buildroot] [PATCH 2/4] pkg-infra: introduce pre/post-step hooks
2013-10-27 17:24 ` [Buildroot] [PATCH 2/4] pkg-infra: introduce pre/post-step hooks Yann E. MORIN
@ 2013-10-27 21:40 ` Thomas De Schampheleire
2013-10-28 14:22 ` Ryan Barnett
2013-10-29 18:43 ` Yann E. MORIN
0 siblings, 2 replies; 20+ messages in thread
From: Thomas De Schampheleire @ 2013-10-27 21:40 UTC (permalink / raw)
To: buildroot
"Yann E. MORIN" <yann.morin.1998@free.fr> wrote:
>From: "Yann E. MORIN" <yann.morin.1998@free.fr>
>
>This hooks will let us instrument the build process in many ways:
> - log current step to see what broke
> - time each step to see what is worth optimising
> - sanity-check installed files (rpath, overwritten files...)
> - call user-provided script
> - ...
>
>The steps are coarse-grain, and all have a 'start' and a 'end' hooks.
>Here is the list of available steps (8 total):
> - extract
> - patch
> - configure
> - build
> - install-host
> - install-staging
> - install-image
> - install-target
>
>The download, clean and uninstall steps are not instrumented on purpose.
>
>Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
>---
> package/pkg-generic.mk | 39 +++++++++++++++++++++++++++++++++++++++
> 1 file changed, 39 insertions(+)
>
>diff --git a/package/pkg-generic.mk b/package/pkg-generic.mk
>index 4bba4b5..799555c 100644
>--- a/package/pkg-generic.mk
>+++ b/package/pkg-generic.mk
>@@ -21,6 +21,29 @@
> ################################################################################
>
> ################################################################################
>+# Helper functions to catch start/end of each steps
each step
>+################################################################################
>+
>+# Those two functions are called by each steps below.
each step
>+# They are responsible for calling all hooks defined in $(STEP_HOOKS)
I personally find the name STEP_HOOKS pretty vague, if you don't know the context you have no clue what it could be. The other hooks POST_EXTRACT etc are clear from their name.
Maybe, GLOBAL_INSTRUMENTATION_HOOKS?
Best regards,
Thomas
^ permalink raw reply [flat|nested] 20+ messages in thread
* [Buildroot] [PATCH 2/4] pkg-infra: introduce pre/post-step hooks
2013-10-27 21:40 ` Thomas De Schampheleire
@ 2013-10-28 14:22 ` Ryan Barnett
2013-10-29 18:43 ` Yann E. MORIN
1 sibling, 0 replies; 20+ messages in thread
From: Ryan Barnett @ 2013-10-28 14:22 UTC (permalink / raw)
To: buildroot
Thomas D, Yann,
Thomas De Schampheleire <patrickdepinguin@gmail.com> wrote on 10/27/2013
04:40:09 PM:
> >
################################################################################
> >
> >
################################################################################
> >+# Helper functions to catch start/end of each steps
>
> each step
>
>
>+################################################################################
> >+
> >+# Those two functions are called by each steps below.
>
> each step
>
> >+# They are responsible for calling all hooks defined in $(STEP_HOOKS)
>
> I personally find the name STEP_HOOKS pretty vague, if you don't know
the
> context you have no clue what it could be. The other hooks POST_EXTRACT
etc
> are clear from their name.
>
> Maybe, GLOBAL_INSTRUMENTATION_HOOKS?
But that is so long to type :)
Thanks,
-Ryan
^ permalink raw reply [flat|nested] 20+ messages in thread
* [Buildroot] [PATCH 2/4] pkg-infra: introduce pre/post-step hooks
2013-10-27 21:40 ` Thomas De Schampheleire
2013-10-28 14:22 ` Ryan Barnett
@ 2013-10-29 18:43 ` Yann E. MORIN
2013-10-29 20:03 ` Thomas De Schampheleire
1 sibling, 1 reply; 20+ messages in thread
From: Yann E. MORIN @ 2013-10-29 18:43 UTC (permalink / raw)
To: buildroot
On 2013-10-27 22:40 +0100, Thomas De Schampheleire spake thusly:
> "Yann E. MORIN" <yann.morin.1998@free.fr> wrote:
> >From: "Yann E. MORIN" <yann.morin.1998@free.fr>
> >This hooks will let us instrument the build process in many ways:
[--SNIP--]
> >diff --git a/package/pkg-generic.mk b/package/pkg-generic.mk
> >index 4bba4b5..799555c 100644
> >--- a/package/pkg-generic.mk
> >+++ b/package/pkg-generic.mk
> >@@ -21,6 +21,29 @@
> > ################################################################################
> >
> > ################################################################################
> >+# Helper functions to catch start/end of each steps
>
> each step
>
> >+################################################################################
> >+
> >+# Those two functions are called by each steps below.
>
> each step
Both: OK.
> >+# They are responsible for calling all hooks defined in $(STEP_HOOKS)
>
> I personally find the name STEP_HOOKS pretty vague, if you don't know
> the context you have no clue what it could be. The other hooks
> POST_EXTRACT etc are clear from their name.
> Maybe, GLOBAL_INSTRUMENTATION_HOOKS?
I'm on the side of Ryan here: it is way too long. :-p
I'll try to see if I can come with a better name, though.
Thanks for the review!
Regards,
Yann E. MORIN.
--
.-----------------.--------------------.------------------.--------------------.
| 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. |
'------------------------------^-------^------------------^--------------------'
^ permalink raw reply [flat|nested] 20+ messages in thread
* [Buildroot] [PATCH 2/4] pkg-infra: introduce pre/post-step hooks
2013-10-29 18:43 ` Yann E. MORIN
@ 2013-10-29 20:03 ` Thomas De Schampheleire
2013-10-29 20:56 ` Yann E. MORIN
0 siblings, 1 reply; 20+ messages in thread
From: Thomas De Schampheleire @ 2013-10-29 20:03 UTC (permalink / raw)
To: buildroot
Hi Yann, Ryan,
On Tue, Oct 29, 2013 at 7:43 PM, Yann E. MORIN <yann.morin.1998@free.fr> wrote:
> On 2013-10-27 22:40 +0100, Thomas De Schampheleire spake thusly:
>> I personally find the name STEP_HOOKS pretty vague, if you don't know
>> the context you have no clue what it could be. The other hooks
>> POST_EXTRACT etc are clear from their name.
>> Maybe, GLOBAL_INSTRUMENTATION_HOOKS?
>
> I'm on the side of Ryan here: it is way too long. :-p
> I'll try to see if I can come with a better name, though.
>
I'm fine with looking at other names, of course, but I don't see how
GLOBAL_INSTRUMENTATION_HOOKS
is longer than
FOO_POST_INSTALL_STAGING_HOOKS
FOO_POST_INSTALL_TARGET_HOOKS
or
CONNTRACK_TOOLS_PRE_CONFIGURE_HOOKS
Besides, it's not that you're writing this so regularly that the
length is really so important, IMHO.
Best regards,
Thomas
^ permalink raw reply [flat|nested] 20+ messages in thread
* [Buildroot] [PATCH 2/4] pkg-infra: introduce pre/post-step hooks
2013-10-29 20:03 ` Thomas De Schampheleire
@ 2013-10-29 20:56 ` Yann E. MORIN
0 siblings, 0 replies; 20+ messages in thread
From: Yann E. MORIN @ 2013-10-29 20:56 UTC (permalink / raw)
To: buildroot
Thomas DS, All,
On 2013-10-29 21:03 +0100, Thomas De Schampheleire spake thusly:
> Hi Yann, Ryan,
>
> On Tue, Oct 29, 2013 at 7:43 PM, Yann E. MORIN <yann.morin.1998@free.fr> wrote:
> > On 2013-10-27 22:40 +0100, Thomas De Schampheleire spake thusly:
>
> >> I personally find the name STEP_HOOKS pretty vague, if you don't know
> >> the context you have no clue what it could be. The other hooks
> >> POST_EXTRACT etc are clear from their name.
> >> Maybe, GLOBAL_INSTRUMENTATION_HOOKS?
> >
> > I'm on the side of Ryan here: it is way too long. :-p
> > I'll try to see if I can come with a better name, though.
> >
>
> I'm fine with looking at other names, of course, but I don't see how
> GLOBAL_INSTRUMENTATION_HOOKS
> is longer than
> FOO_POST_INSTALL_STAGING_HOOKS
> FOO_POST_INSTALL_TARGET_HOOKS
> or
> CONNTRACK_TOOLS_PRE_CONFIGURE_HOOKS
>
> Besides, it's not that you're writing this so regularly that the
> length is really so important, IMHO.
Yeah, yeah, right. :-)
Regards,
Yann E. MORIN.
--
.-----------------.--------------------.------------------.--------------------.
| 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. |
'------------------------------^-------^------------------^--------------------'
^ permalink raw reply [flat|nested] 20+ messages in thread
* [Buildroot] [PATCH 3/4] pkg-infra: add hook to log timing of steps
2013-10-27 17:24 ` [Buildroot] [PATCH 1/4] post-{build, images} hooks: export BUILD_DIR too Yann E. MORIN
2013-10-27 17:24 ` [Buildroot] [PATCH 2/4] pkg-infra: introduce pre/post-step hooks Yann E. MORIN
@ 2013-10-27 17:24 ` Yann E. MORIN
2013-10-27 17:24 ` [Buildroot] [PATCH 4/4] pkg-infra: add user-supplied step-hooks Yann E. MORIN
2013-10-27 21:12 ` [Buildroot] [PATCH 1/4] post-{build, images} hooks: export BUILD_DIR too Thomas De Schampheleire
3 siblings, 0 replies; 20+ messages in thread
From: Yann E. MORIN @ 2013-10-27 17:24 UTC (permalink / raw)
To: buildroot
From: "Yann E. MORIN" <yann.morin.1998@free.fr>
The timing information is stored in the file $(O)/build-time.log
Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
---
package/pkg-generic.mk | 11 +++++++++++
1 file changed, 11 insertions(+)
diff --git a/package/pkg-generic.mk b/package/pkg-generic.mk
index 799555c..72e0e82 100644
--- a/package/pkg-generic.mk
+++ b/package/pkg-generic.mk
@@ -43,6 +43,17 @@ define step_end
$(foreach hook,$(STEP_HOOKS),$(call $(hook),end,$(1),$($(PKG)_NAME))$(sep))
endef
+#######################################
+# Actual steps hooks
+
+# Time steps
+define step_time
+ printf "%s:%-5.5s:%-20.20s: %s\n" \
+ "$$(date +%s)" "$(1)" "$(2)" "$(3)" \
+ >>"$(BUILD_DIR)/build-time.log"
+endef
+STEP_HOOKS += step_time
+
################################################################################
# Implicit targets -- produce a stamp file for each step of a package build
################################################################################
--
1.8.1.2
^ permalink raw reply related [flat|nested] 20+ messages in thread* [Buildroot] [PATCH 4/4] pkg-infra: add user-supplied step-hooks
2013-10-27 17:24 ` [Buildroot] [PATCH 1/4] post-{build, images} hooks: export BUILD_DIR too Yann E. MORIN
2013-10-27 17:24 ` [Buildroot] [PATCH 2/4] pkg-infra: introduce pre/post-step hooks Yann E. MORIN
2013-10-27 17:24 ` [Buildroot] [PATCH 3/4] pkg-infra: add hook to log timing of steps Yann E. MORIN
@ 2013-10-27 17:24 ` Yann E. MORIN
2013-10-27 21:12 ` [Buildroot] [PATCH 1/4] post-{build, images} hooks: export BUILD_DIR too Thomas De Schampheleire
3 siblings, 0 replies; 20+ messages in thread
From: Yann E. MORIN @ 2013-10-27 17:24 UTC (permalink / raw)
To: buildroot
From: "Yann E. MORIN" <yann.morin.1998@free.fr>
Allow user to supply their own step-hooks by passing a variable
on the make command-line:
make BR2_STEP_USER_HOOK=/path/to/my/script
This can be usefull to run site-specific actions at each step of the
build process, such as logging installed, removed or modified files,
do sanity checks on installed files...
It is possible to call more than one script, by passing a space-separated
lists of scripts to call.
Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
---
docs/manual/debugging-buildroot.txt | 33 +++++++++++++++++++++++++++++++++
docs/manual/developer-guide.txt | 2 ++
package/pkg-generic.mk | 9 +++++++++
3 files changed, 44 insertions(+)
create mode 100644 docs/manual/debugging-buildroot.txt
diff --git a/docs/manual/debugging-buildroot.txt b/docs/manual/debugging-buildroot.txt
new file mode 100644
index 0000000..7e66208
--- /dev/null
+++ b/docs/manual/debugging-buildroot.txt
@@ -0,0 +1,33 @@
+// -*- mode:doc; -*-
+// vim: set syntax=asciidoc:
+
+[[debugging-buildroot]]
+
+Debugging Buildroot
+-------------------
+
+It is possible to instrument the steps +Buildroot+ does when building
+packages. Define the variable +BR2_STEPS_USER_HOOKS+ to contain the path
+of one or more scripts (or other executables), in a space-separated list,
+you want called before and after each step. The script is called with
+three parameters:
+
+ - +start+ or +end+ to denote the start (resp. the end) of a step;
+ - the name of the step about to be started, or which just ended.
+ - the name of the package
+
+For example :
+
+----
+make BR2_STEPS_USER_HOOKS="/path/to/my/script1 /path/to/my/script2"
+----
+
+That script has access to the following variables:
+
+ - +BUILDROOT_CONFIG+: the path to the Buildroot .config file
+ - +HOST_DIR+, +STAGING_DIR+, +TARGET_DIR+: see
+ xref:generic-package-reference[]
+ - +BUILD_DIR+: the directory where packages are extracted and built
+ - +BINARIES_DIR+: the place where all binary files (aka images) are
+ stored
+ - +BASE_DIR+: the base output directory
diff --git a/docs/manual/developer-guide.txt b/docs/manual/developer-guide.txt
index 43272f5..2e6b7aa 100644
--- a/docs/manual/developer-guide.txt
+++ b/docs/manual/developer-guide.txt
@@ -13,3 +13,5 @@ include::patch-policy.txt[]
include::download-infra.txt[]
include::board-support.txt[]
+
+include::debugging-buildroot.txt[]
diff --git a/package/pkg-generic.mk b/package/pkg-generic.mk
index 72e0e82..625dabc 100644
--- a/package/pkg-generic.mk
+++ b/package/pkg-generic.mk
@@ -54,6 +54,15 @@ define step_time
endef
STEP_HOOKS += step_time
+# User-supplied script
+define step_user
+ @$(foreach user_hook, $(BR2_STEPS_USER_HOOKS), \
+ $(USER_HOOKS_EXTRA_ENV) $(user_hook) "$(1)" "$(2)" "$(3)"$(sep))
+endef
+ifneq ($(BR2_STEPS_USER_HOOKS),)
+STEP_HOOKS += step_user
+endif
+
################################################################################
# Implicit targets -- produce a stamp file for each step of a package build
################################################################################
--
1.8.1.2
^ permalink raw reply related [flat|nested] 20+ messages in thread* [Buildroot] [PATCH 1/4] post-{build, images} hooks: export BUILD_DIR too
2013-10-27 17:24 ` [Buildroot] [PATCH 1/4] post-{build, images} hooks: export BUILD_DIR too Yann E. MORIN
` (2 preceding siblings ...)
2013-10-27 17:24 ` [Buildroot] [PATCH 4/4] pkg-infra: add user-supplied step-hooks Yann E. MORIN
@ 2013-10-27 21:12 ` Thomas De Schampheleire
2013-10-28 5:17 ` Thomas Petazzoni
2013-10-29 18:35 ` Yann E. MORIN
3 siblings, 2 replies; 20+ messages in thread
From: Thomas De Schampheleire @ 2013-10-27 21:12 UTC (permalink / raw)
To: buildroot
"Yann E. MORIN" <yann.morin.1998@free.fr> wrote:
>From: "Yann E. MORIN" <yann.morin.1998@free.fr>
>
>Also export BUILD_DIR for post-{build,images} hooks, so they do have
>a place to store generated files.
>
>Note: this will be more einteresting for the instrumentation of steps,
>to come in a later patch.
>
>Signed-off-by: "Yann E. MORIN" <yann.morin.1998@free.fr>
>---
> Makefile | 4 ++--
> docs/manual/customize-rootfs.txt | 5 +++--
> package/Makefile.in | 5 +++++
> 3 files changed, 10 insertions(+), 4 deletions(-)
>
>diff --git a/Makefile b/Makefile
>index f266e2d..0113f75 100644
>--- a/Makefile
>+++ b/Makefile
>@@ -511,7 +511,7 @@ endif
>
> @$(foreach s, $(call qstrip,$(BR2_ROOTFS_POST_BUILD_SCRIPT)), \
> $(call MESSAGE,"Executing post-build script $(s)"); \
>- $(s) $(TARGET_DIR) $(call qstrip,$(BR2_ROOTFS_POST_SCRIPT_ARGS))$(sep))
>+ $(USER_HOOKS_EXTRA_ENV) $(s) $(TARGET_DIR) $(call qstrip,$(BR2_ROOTFS_POST_SCRIPT_ARGS))$(sep))
>
> ifeq ($(BR2_ENABLE_LOCALE_PURGE),y)
> LOCALE_WHITELIST=$(BUILD_DIR)/locales.nopurge
>@@ -557,7 +557,7 @@ endif
> target-post-image:
> @$(foreach s, $(call qstrip,$(BR2_ROOTFS_POST_IMAGE_SCRIPT)), \
> $(call MESSAGE,"Executing post-image script $(s)"); \
>- $(s) $(BINARIES_DIR) $(call qstrip,$(BR2_ROOTFS_POST_SCRIPT_ARGS))$(sep))
>+ $(USER_HOOKS_EXTRA_ENV) $(s) $(BINARIES_DIR) $(call qstrip,$(BR2_ROOTFS_POST_SCRIPT_ARGS))$(sep))
>
> toolchain-eclipse-register:
> ./support/scripts/eclipse-register-toolchain `readlink -f $(O)` $(notdir $(TARGET_CROSS)) $(BR2_ARCH)
>diff --git a/docs/manual/customize-rootfs.txt b/docs/manual/customize-rootfs.txt
>index 49a6b4b..450b3d5 100644
>--- a/docs/manual/customize-rootfs.txt
>+++ b/docs/manual/customize-rootfs.txt
>@@ -41,6 +41,7 @@ there are a few ways to customize the resulting target filesystem.
> - +BUILDROOT_CONFIG+: the path to the Buildroot .config file
> - +HOST_DIR+, +STAGING_DIR+, +TARGET_DIR+: see
> xref:generic-package-reference[]
>+ - +BUILD_DIR+: the directory where packages are extracted and built
> - +BINARIES_DIR+: the place where all binary files (aka images) are
> stored
> - +BASE_DIR+: the base output directory
>@@ -78,8 +79,8 @@ in one of these _post-image scripts_ will require special handling
>
> Just like for the _post-build scripts_ mentioned above, you also have
> access to the following environment variables from your _post-image
>-scripts_: +BUILDROOT_CONFIG+, +HOST_DIR+, +STAGING_DIR+, +TARGET_DIR+,
>-+BINARIES_DIR+ and +BASE_DIR+.
>+scripts_: +BUILDROOT_CONFIG+, +BUILD_DIR+, +HOST_DIR+, +STAGING_DIR+,
>++TARGET_DIR+, +BINARIES_DIR+ and +BASE_DIR+.
>
> Additionally, each of the +BR2_ROOTFS_POST_BUILD_SCRIPT+ and
> +BR2_ROOTFS_POST_IMAGE_SCRIPT+ scripts will be passed the arguments
>diff --git a/package/Makefile.in b/package/Makefile.in
>index 612f3c7..2224f27 100644
>--- a/package/Makefile.in
>+++ b/package/Makefile.in
>@@ -275,6 +275,11 @@ HOST_MAKE_ENV=PATH=$(HOST_PATH) \
> PKG_CONFIG_LIBDIR="$(HOST_DIR)/usr/lib/pkgconfig" \
> PERLLIB="$(HOST_DIR)/usr/lib/perl"
>
>+# This extra environment we can not export ourselves, so we have
>+# to expicitly pass it to user-supplied external hooks (eg.
>+# post-build, post-images)
>+USER_HOOKS_EXTRA_ENV=\
>+ BUILD_DIR=$(BUILD_DIR)
I'd add a bit more info here: we cannot export BUILD_DIR globally because some packages, like uboot, also use this same variable for another purpose.
Best regards,
Thomas
^ permalink raw reply [flat|nested] 20+ messages in thread* [Buildroot] [PATCH 1/4] post-{build, images} hooks: export BUILD_DIR too
2013-10-27 21:12 ` [Buildroot] [PATCH 1/4] post-{build, images} hooks: export BUILD_DIR too Thomas De Schampheleire
@ 2013-10-28 5:17 ` Thomas Petazzoni
2013-10-29 18:41 ` Yann E. MORIN
2013-10-29 20:08 ` Thomas De Schampheleire
2013-10-29 18:35 ` Yann E. MORIN
1 sibling, 2 replies; 20+ messages in thread
From: Thomas Petazzoni @ 2013-10-28 5:17 UTC (permalink / raw)
To: buildroot
Dear Thomas De Schampheleire,
On Sun, 27 Oct 2013 22:12:34 +0100, Thomas De Schampheleire wrote:
> >+# This extra environment we can not export ourselves, so we have
> >+# to expicitly pass it to user-supplied external hooks (eg.
> >+# post-build, post-images)
> >+USER_HOOKS_EXTRA_ENV=\
> >+ BUILD_DIR=$(BUILD_DIR)
>
> I'd add a bit more info here: we cannot export BUILD_DIR globally because some packages, like uboot, also use this same variable for another purpose.
(Unfortunately, we've asked you to not wrapped patches you reply to,
but now, it has the consequence that you no longer wrap what you write.
Well, I guess with K9 it's hard to get both).
Regarding BUILD_DIR and other variables being exported, is it really
safe to export other variables with a relatively generic name such as
TARGET_DIR, BASE_DIR, HOST_DIR, BINARIES_DIR, etc. ? Should we instead
expose them to post-build/post-image scripts as BR2_<something> ? But
well, of course, it means breaking the existing API, which isn't nice.
Thomas
--
Thomas Petazzoni, CTO, Free Electrons
Embedded Linux, Kernel and Android engineering
http://free-electrons.com
^ permalink raw reply [flat|nested] 20+ messages in thread* [Buildroot] [PATCH 1/4] post-{build, images} hooks: export BUILD_DIR too
2013-10-28 5:17 ` Thomas Petazzoni
@ 2013-10-29 18:41 ` Yann E. MORIN
2013-10-29 20:08 ` Thomas De Schampheleire
1 sibling, 0 replies; 20+ messages in thread
From: Yann E. MORIN @ 2013-10-29 18:41 UTC (permalink / raw)
To: buildroot
Thomas P, All,
On 2013-10-28 06:17 +0100, Thomas Petazzoni spake thusly:
> Dear Thomas De Schampheleire,
>
> On Sun, 27 Oct 2013 22:12:34 +0100, Thomas De Schampheleire wrote:
>
> > >+# This extra environment we can not export ourselves, so we have
> > >+# to expicitly pass it to user-supplied external hooks (eg.
> > >+# post-build, post-images)
> > >+USER_HOOKS_EXTRA_ENV=\
> > >+ BUILD_DIR=$(BUILD_DIR)
[--SNIP--]
> Regarding BUILD_DIR and other variables being exported, is it really
> safe to export other variables with a relatively generic name such as
> TARGET_DIR, BASE_DIR, HOST_DIR, BINARIES_DIR, etc. ? Should we instead
> expose them to post-build/post-image scripts as BR2_<something> ? But
> well, of course, it means breaking the existing API, which isn't nice.
If we export all of those variables with this mechanism rathe than with
the make's 'export', then we again dwell on the sagfe side, and we need
not rename them.
We should have named them BR2_something from the beginning, even for our
internal use, to avoid any name-clashing with the calling environment.
For example:
$ export BUILD_DIR=/path/to/my/project/build.dir
$ mkdir -p "${BUILD_DIR}/buildroot.output"
$ make -C "${BUILD_DIR}//buildroot.output"
Suppose the user has post-{build,image} or other rsource files (eg.
kernel .config) in its ${BUILD_DIR}, then his/her configuration is
broken.
But that's the way story goes, we fscked up at the beginning, we have to
live with them, now... :-(
Anyway, I'll keep this change as-is, and make a new cset that export all
these variables to using this new mechanism, so they only get exported
for post-{build,image} scripts (and the new steps-user-hook).
Regards,
Yann E. MORIN.
--
.-----------------.--------------------.------------------.--------------------.
| 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. |
'------------------------------^-------^------------------^--------------------'
^ permalink raw reply [flat|nested] 20+ messages in thread* [Buildroot] [PATCH 1/4] post-{build, images} hooks: export BUILD_DIR too
2013-10-28 5:17 ` Thomas Petazzoni
2013-10-29 18:41 ` Yann E. MORIN
@ 2013-10-29 20:08 ` Thomas De Schampheleire
1 sibling, 0 replies; 20+ messages in thread
From: Thomas De Schampheleire @ 2013-10-29 20:08 UTC (permalink / raw)
To: buildroot
Hi Thomas,
On Mon, Oct 28, 2013 at 6:17 AM, Thomas Petazzoni
<thomas.petazzoni@free-electrons.com> wrote:
[..]
>
> (Unfortunately, we've asked you to not wrapped patches you reply to,
> but now, it has the consequence that you no longer wrap what you write.
> Well, I guess with K9 it's hard to get both).
>
Hmm :-o
I'm not sure if I can easily fix this with K9. My earlier bug report
and even partial patch on the k9 mailing list didn't get any response.
I'll check the source but I'll try not to write long sentences in the
mean time ;-)
Best regards,
Thomas
^ permalink raw reply [flat|nested] 20+ messages in thread
* [Buildroot] [PATCH 1/4] post-{build, images} hooks: export BUILD_DIR too
2013-10-27 21:12 ` [Buildroot] [PATCH 1/4] post-{build, images} hooks: export BUILD_DIR too Thomas De Schampheleire
2013-10-28 5:17 ` Thomas Petazzoni
@ 2013-10-29 18:35 ` Yann E. MORIN
1 sibling, 0 replies; 20+ messages in thread
From: Yann E. MORIN @ 2013-10-29 18:35 UTC (permalink / raw)
To: buildroot
Thomas DS, All,
On 2013-10-27 22:12 +0100, Thomas De Schampheleire spake thusly:
> "Yann E. MORIN" <yann.morin.1998@free.fr> wrote:
> >From: "Yann E. MORIN" <yann.morin.1998@free.fr>
> >
> >Also export BUILD_DIR for post-{build,images} hooks, so they do have
> >a place to store generated files.
[--SNIP--]
> >+# This extra environment we can not export ourselves, so we have
> >+# to expicitly pass it to user-supplied external hooks (eg.
> >+# post-build, post-images)
> >+USER_HOOKS_EXTRA_ENV=\
> >+ BUILD_DIR=$(BUILD_DIR)
>
> I'd add a bit more info here: we cannot export BUILD_DIR globally
> because some packages, like uboot, also use this same variable for
> another purpose.
Will do, thanks.
Regards,
Yann E. MORIN.
--
.-----------------.--------------------.------------------.--------------------.
| 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. |
'------------------------------^-------^------------------^--------------------'
^ permalink raw reply [flat|nested] 20+ messages in thread