boot/barebox: add renaming functionality to barebox image copy
Steinhilber
PATCH 1/1 boot/barebox: add renaming functionality to barebox image copy
Until now barebox images are copied to the output/images directory with their default name. This is a problem if the barebox and barebox-aux images have the same name. Also, you need to rename the images in a post-build script if you need certain file names.
With this patch there is a new option in the barebox and barebox-aux config, which allows you to copy the image files with target names of your choice. See the help text of the option for a more detailed explanation.
--- boot/barebox/barebox-aux/Config.in | 18 ++++++++++++++++++ boot/barebox/barebox.mk | 23 ++++++++++++++++++++--- boot/barebox/barebox/Config.in | 18 ++++++++++++++++++ 3 files changed, 56 insertions(+), 3 deletions(-)
boot/barebox/barebox-aux/Config.in +18 -0
@@ -39,6 +39,24 @@ config BR2_TARGET_BAREBOX_AUX_IMAGE_FILE - barebox.bin for barebox versions older than 2012.10. - barebox-flash-image for later versions. +config BR2_TARGET_BAREBOX_AUX_IMAGE_FILE_TARGETS + string "Image file copy target names" + help + Space-separated list of target file names used when copying + the image files from BR2_TARGET_BAREBOX_IMAGE_FILE to the + images directory. + + The target names are applied in their order in the list. So the + first file in BR2_TARGET_BAREBOX_IMAGE_FILE is named after the + first entry in this list and so on. + + If left empty or the number of names is smaller than the number + of files in BR2_TARGET_BAREBOX_IMAGE_FILE the original file + name is kept. + + If BR2_TARGET_BAREBOX_IMAGE_FILE is left empty, the default file + is named after the first entry in this list. + config BR2_TARGET_BAREBOX_AUX_CUSTOM_ENV bool "Generate an environment image" help
boot/barebox/barebox.mk +21 -3
@@ -110,14 +110,31 @@ define $(1)_BUILD_CMDS endef $(1)_IMAGE_FILES = $$(call qstrip,$$(BR2_TARGET_$(1)_IMAGE_FILE)) +$(1)_IMAGE_FILES_TARGETS = $$(call +qstrip,$$(BR2_TARGET_$(1)_IMAGE_FILE_TARGETS)) define $(1)_INSTALL_IMAGES_CMDS + image_files_array=($$($(1)_IMAGE_FILES)); \ + image_targets_array=($$($(1)_IMAGE_FILES_TARGETS)); \ if test -n "$$($(1)_IMAGE_FILES)"; then \ - cp -L $$(foreach image,$$($(1)_IMAGE_FILES),$$(@D)/$$(image)) $$(BINARIES_DIR) ; \ + if test -n "$$($(1)_IMAGE_FILES_TARGETS)"; then \ + for index in $$$${!image_files_array[*]}; do \ + cp -L $$(@D)/$$$${image_files_array[$$$$index]} $$(BINARIES_DIR)/$$$${image_targets_array[$$$$index]}; \ + done; \ + else \ + cp -L $$(foreach image,$$($(1)_IMAGE_FILES),$$(@D)/$$(image)) $$(BINARIES_DIR) ; \ + fi \ elif test -h $$(@D)/barebox-flash-image ; then \ - cp -L $$(@D)/barebox-flash-image $$(BINARIES_DIR)/barebox.bin ; \ + if test -n "$$($(1)_IMAGE_FILES_TARGETS)"; then \ + cp -L $$(@D)/barebox-flash-image $$(BINARIES_DIR)/$$$${image_targets_array[0]} ; \ + else \ + cp -L $$(@D)/barebox-flash-image $$(BINARIES_DIR)/barebox.bin ; \ + fi \ else \ - cp $$(@D)/barebox.bin $$(BINARIES_DIR);\ + if test -n "$$($(1)_IMAGE_FILES_TARGETS)"; then \ + cp $$(@D)/barebox.bin $$(BINARIES_DIR)/$$$${image_targets_array[0]};\ + else \ + cp $$(@D)/barebox.bin $$(BINARIES_DIR);\ + fi \ fi $$($(1)_INSTALL_CUSTOM_ENV) endef
boot/barebox/barebox/Config.in +18 -0
@@ -39,6 +39,24 @@ config BR2_TARGET_BAREBOX_IMAGE_FILE - barebox.bin for barebox versions older than 2012.10. - barebox-flash-image for later versions. +config BR2_TARGET_BAREBOX_IMAGE_FILE_TARGETS + string "Image file copy target names" + help + Space-separated list of target file names used when copying + the image files from BR2_TARGET_BAREBOX_IMAGE_FILE to the + images directory. + + The target names are applied in their order in the list. So the + first file in BR2_TARGET_BAREBOX_IMAGE_FILE is named after the + first entry in this list and so on. + + If left empty or the number of names is smaller than the number + of files in BR2_TARGET_BAREBOX_IMAGE_FILE the original file + name is kept. + + If BR2_TARGET_BAREBOX_IMAGE_FILE is left empty, the default file + is named after the first entry in this list. + config BR2_TARGET_BAREBOX_BAREBOXENV bool "bareboxenv tool in target" help
--
2.11.0
________________________________
Erbe Elektromedizin GmbH Firmensitz: 72072 Tuebingen Geschaeftsfuehrer: Christian O. Erbe, Reiner Thede Registergericht: Stuttgart HRB 380137
PATCH 1/1 boot/barebox: add renaming functionality to barebox image copy
Hello Markus,
Quoted 3 lines · Markus
Until now barebox images are copied to the output/images directory with their default name. This is a problem if the barebox and barebox-aux images have the same name.
Could you describe a specific case/situation where this would happen ? The main reason we have barebox vs. barebox-aux is because you sometimes need to build a full-blown Barebox, and a smaller Barebox that serves a first stage bootloader. From what I remember the generated images had different names, don't they ?
Quoted 2 lines
Also, you need to rename the images in a post-build script if you need certain file names.
That is a pretty normal thing in Buildroot. We just install things as they are installed by the upstream build system, and leave it up to custom post-build script to further rename/move/adjust to match the specific requirements of the project/user.
boot/barebox/barebox-aux/Config.in config BR2_TARGET_BAREBOX_AUX_IMAGE_FILE · line 51
Quoted 10 lines
boot/barebox/barebox-aux/Config.in +10
-0+config BR2_TARGET_BAREBOX_AUX_IMAGE_FILE_TARGETS + string "Image file copy target names" + help + Space-separated list of target file names used when copying + the image files from BR2_TARGET_BAREBOX_IMAGE_FILE to the + images directory. + + The target names are applied in their order in the list. So the + first file in BR2_TARGET_BAREBOX_IMAGE_FILE is named after the + first entry in this list and so on.
I don't think there is any other option in Buildroot where we have two space-separated lists where there is a mapping between each item in one list with the corresponding item in the other list. It's a pretty weird semantic.
Perhaps a less weird semantic (which would also simplify the implementation I believe) would be to have:
name1:target-name1 name2:target-name2
in the existing BR2_TARGET_BAREBOX_IMAGE_FILE option.
Then you can do:
$(foreach f,$(BR2_TARGET_BAREBOX_IMAGE_FILE), $(if $(findstring,:,$(f), cp $(@D)/$(word 0,$(subst :,$(space),$(f)) $(BINARIES_DIR)/$(word 1,$(subst :,$(space),$(f), cp $(@D)/$(f) $(BINARIES_DIR)/$(f) ) )
Well, it's not that simple and of course completely untested :) And perhaps it doesn't fit well with the existing shell code in barebox.mk.
boot/barebox/barebox.mk define $(1)_BUILD_CMDS endef · line 117
Quoted 3 lines
define $(1)_INSTALL_IMAGES_CMDS
boot/barebox/barebox.mk +2
-0+ image_files_array=($$($(1)_IMAGE_FILES)); \ + image_targets_array=($$($(1)_IMAGE_FILES_TARGETS)); \
We don't use bash arrays anywhere else in the make code in Buildroot, so this would also be a precedent.
Best regardsn
Thomas
Signature · 3 lines
Thomas Petazzoni, CTO, Bootlin Embedded Linux and Kernel engineering https://bootlin.com