Some versions have introduced backward incompatibilities. This section explains those incompatibilities, and for each explains what to do to complete the migration.
To migrate from an older Buildroot version, take the following steps.
make graph-size
. Save
graphs/file-size-stats.csv
in a different location. Run make
clean
to remove the rest.
make menuconfig
starting from the existing .config
.
packages
directory and run
git log <old version>.. — <your packages>
.
make graph-size
.
file-size-stats.csv
with the original one, to
check if no required files have disappeared and if no new big unneeded
files have appeared.
Before Buildroot 2016.11, it was possible to use only one br2-external tree at once. With Buildroot 2016.11 came the possibility to use more than one simultaneously (for details, see Section 9.2, “Keeping customizations outside of Buildroot”).
This however means that older br2-external trees are not usable as-is. A minor change has to be made: adding a name to your br2-external tree.
This can be done very easily in just a few steps:
First, create a new file named external.desc
, at the root of your
br2-external tree, with a single line defining the name of your
br2-external tree:
$ echo 'name: NAME_OF_YOUR_TREE' >external.desc
Note. Be careful when choosing a name: It has to be unique and be made
with only ASCII characters from the set [A-Za-z0-9_]
.
Then, change every occurrence of BR2_EXTERNAL
in your br2-external
tree with the new variable:
$ find . -type f | xargs sed -i 's/BR2_EXTERNAL/BR2_EXTERNAL_NAME_OF_YOUR_TREE_PATH/g'
Now, your br2-external tree can be used with Buildroot 2016.11 onward.
Note: This change makes your br2-external tree incompatible with Buildroot before 2016.11.
Before Buildroot 2017.08, host packages were installed in $(HOST_DIR)/usr
(with e.g. the autotools' --prefix=$(HOST_DIR)/usr
). With Buildroot
2017.08, they are now installed directly in $(HOST_DIR)
.
Whenever a package installs an executable that is linked with a library
in $(HOST_DIR)/lib
, it must have an RPATH pointing to that directory.
An RPATH pointing to $(HOST_DIR)/usr/lib
is no longer accepted.
Before Buildroot 2023.11, the subversion download backend unconditionally
retrieved the external references (objects with an svn:externals
property). Starting with 2023.11, externals are no longer retrieved by
default; if you need them, set LIBFOO_SVN_EXTERNALS
to YES
. This
change implies that:
-br3
, so the hash
files must be updated appropriately.
Before Buildroot 2023.11, it was possible (but undocumented and unused)
to apply architecture-specific patches, by prefixing the patch filename
with the architecture, e.g. 0001-some-changes.patch.arm
and such a
patch would only be applied for that architecture. With Buildroot 2023.11,
this is no longer supported, and such patches are no longer applied at
all.
If you still need per-architecture patches, then you may provide a pre-patch hook that copies the patches applicable to the configured architecture, e.g.:
define LIBFOO_ARCH_PATCHES $(foreach p,$(wildcard $(LIBFOO_PKGDIR)/*.patch.$(ARCH)), \ cp -f $(p) $(patsubst %.$(ARCH),%,$(p)) ) endef LIBFOO_PRE_PATCH_HOOKS += LIBFOO_ARCH_PATCHES
Note that no package in Buildroot has architecture-specific patches, and that such patches will most probably not be accepted.
The download backends have been extended in various ways.
default
ACL set). This impacts the archives generated for
git and subversion repositories, as well as those for vendored cargo
and go packages.
export-subst
git attribute when generating
archives.
tar
version, 1.35, is required to generate the archives.
For compatibility reasons, tar
1.35 changes the way it stores some
fields (devmajor
and devminor
), which has an impact in the metadata
stored in the archives (but the content of files is not affected).
To accommodate those changes, the archive suffix has been updated or added:
-git4
-svn5
-cargo2
-go2
Note that, if two such prefixes would apply to a generated archive, like
for a cargo package downloaded from git, both suffixes need to be added,
first the one for the download mechanism, then the one for the vendoring,
e.g.: libfoo-1.2.3-git4-cargo2.tar.gz
.
Because of this, the hash file of any custom packages or custom versions for kernel and bootloaders must be updated. The following sed scripts can automate the rename in the hash file (assuming such files are kept under git):
# For git and svn packages, which originally had -br2 resp. -br3 suffix sed -r -i -e 's/-br2/-git4/; s/-br3/-svn5/' $( git grep -l -E -- '-br2|-br3' -- '*.hash' ) # For go packages, which originally had no suffix sed -r -i -e 's/(\.tar\.gz)$/-go2\1/' $( git grep -l -E '\$\(eval \$\((host-)?golang-package\)\)' -- '*.mk' \ |sed -r -e 's/\.mk$/.hash/' \ |sort -u ) # For cargo packages, which originally had no suffix sed -r -i -e 's/(\.tar\.gz)$/-cargo2\1/' $( git grep -l -E '\$\(eval \$\((host-)?cargo-package\)\)' -- '*.mk' \ |sed -r -e 's/\.mk$/.hash/' \ |sort -u )
Note that the hash will have changed, so that needs to be updated (manually) as well.