Support for multiple BR2_GLOBAL_PATCH_DIR
PATCH v6 1/2 Support for multiple BR2_GLOBAL_PATCH_DIR
Adding support for specifying multiple directories in BR2_GLOBAL_PATCH_DIR. This will allow for a layered approach for the patching of a package.
---
Changes v3 -> v6:
- None
Changes v2 -> v3:
- changed the generation of patch directories to use 'addsuffix' instead of a foreach loop. (suggested by Arnout)
Changes v1 -> v2:
- change wording in Config.in help (suggested by Thomas D)
--- Config.in | 20 ++++++++++++-------- package/pkg-generic.mk | 5 ++++- 2 files changed, 16 insertions(+), 9 deletions(-)
Config.in +12 -8
@@ -461,18 +461,22 @@ config BR2_PACKAGE_OVERRIDE_FILE Buildroot documentation for more details on this feature. config BR2_GLOBAL_PATCH_DIR - string "global patch directory" + string "global patch directories" help - You may specify a directory containing global package patches. - For a specific version <packageversion> of a specific package - <packagename>, patches are applied as follows. + You may specify a space separated list of one or more directories + containing global package patches. For a specific version + <packageversion> of a specific package <packagename>, patches are + applied as follows: - First, the default Buildroot patch set for the package is applied. + First, the default Buildroot patch set for the package is applied + from the package's directory in Buildroot. - If the directory $(BR2_GLOBAL_PATCH_DIR)/<packagename>/<packageversion> - exists, then all *.patch files in the directory will be applied. + Then for every directory - <global-patch-dir> - that exists in + BR2_GLOBAL_PATCH_DIR, if the directory + <global-patch-dir>/<packagename>/<packageversion>/ exists, then all + *.patch files in this directory will be applied. - Otherwise, if the directory $(BR2_GLOBAL_PATCH_DIR)/<packagename> exists, + Otherwise, if the directory <global-patch-dir>/<packagename> exists, then all *.patch files in the directory will be applied. endmenu
package/pkg-generic.mk +4 -1
@@ -134,8 +134,11 @@ endif # The RAWNAME variable is the lowercased package name, which allows to # find the package directory (typically package/<pkgname>) and the # prefix of the patches +# +# For BR2_GLOBAL_PATCH_DIR, only generate if it is defined $(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: PATCH_BASE_DIRS = $($(PKG)_DIR_PREFIX)/$(RAWNAME) +$(BUILD_DIR)/%/.stamp_patched: PATCH_BASE_DIRS += $(addsuffix /$(RAWNAME),$(call qstrip,$(BR2_GLOBAL_PATCH_DIR))) $(BUILD_DIR)/%/.stamp_patched: @$(call step_start,patch) @$(call MESSAGE,"Patching")
Signature · 1 line
1.7.9.5
PATCH v6 2/2 manual: update for multiple global patch dirs
Updating the documentation to reflect that multiple directories can now be specified for BR2_GLOBAL_PATCH_DIR. Along with giving an example use case of how to use multiple global patch directories.
---
Changes v4 -> v6:
- Minor wording that was missed from feedback received by Thomas D in v4.
Changes v4 -> v5:
- Fixed minor wording issue and spelling (suggested by Thomas D)
Changes v3 -> v4:
- Fixed minor spelling mistakes and wording (suggested by Arnout)
- Reword section about order that patches are applied along with making it clearer about when to use BR2_GLOBAL_PATCH_DIR (suggested by Arnout)
Changes v2 -> v3:
- None
Changes v1 -> v2:
- Fixed minor spelling mistakes and wording (suggested by Thomas D)
--- docs/manual/customize-packages.txt | 92 ++++++++++++++++++++++++++++++++---- docs/manual/patch-policy.txt | 20 +++++--- 2 files changed, 96 insertions(+), 16 deletions(-)
docs/manual/customize-packages.txt +83 -9
@@ -8,16 +8,90 @@ It is sometimes useful to apply 'extra' patches to packages - over and above those provided in Buildroot. This might be used to support custom features in a project, for example, or when working on a new architecture. -The +BR2_GLOBAL_PATCH_DIR+ configuration file option can be -used to specify a directory containing global package patches. +The +BR2_GLOBAL_PATCH_DIR+ configuration option can be used to specify +a space separated list of one or more directories containing package +patches. By specifying multiple global patch directories, a user could +implement a layered approach to patches. This could be useful when a +user has multiple boards that share a common processor architecture. +It is often the case that a subset of patches for a package need to be +shared between the different boards a user has. However, each board +may require specific patches for the package that build on top of the +common subset of patches. -For a specific version <packageversion> of a specific package <packagename>, -patches are applied as follows. +For a specific version +<packageversion>+ of a specific package ++<packagename>+, patches are applied from +BR2_GLOBAL_PATCH_DIR+ as +follows: -First, the default Buildroot patch set for the package is applied. +. For every directory - +<global-patch-dir>+ - that exists in + +BR2_GLOBAL_PATCH_DIR+, a +<package-patch-dir>+ will be determined as + follows: ++ +* +<global-patch-dir>/<packagename>/<packageversion>/+ if the + directory exists. ++ +* Otherwise, +<global-patch-dir>/<packagename>+ if the directory + exists. -If the directory +$(BR2_GLOBAL_PATCH_DIR)/<packagename>/<packageversion>+ -exists, then all +*.patch+ files in the directory will be applied. +. Patches will then be applied from a +<package-patch-dir>+ as + follows: ++ +* If a +series+ file exists in the package directory, then patches are + applied according to the +series+ file; ++ +* Otherwise, patch files matching +<packagename>-*.patch+ + are applied in alphabetical order. + So, to ensure they are applied in the right order, it is highly + recommended to name the patch files like this: + +<packagename>-<number>-<description>.patch+, where +<number>+ + refers to the 'apply order'. -Otherwise, if the directory +$(BR2_GLOBAL_PATCH_DIR)/<packagename>+ -exists, then all +*.patch+ files in the directory will be applied. +For information about how patches are applied for a package, see +xref:patch-apply-order[] + +The +BR2_GLOBAL_PATCH_DIR+ option is the preferred method for +specifying a custom patch directory for packages. It can be used to +specify a patch directory for any package in buildroot. It should also +be used in place of the custom patch directory options that are +available for packages such as U-Boot and Barebox. By doing this, it +will allow a user to manage their patches from one top-level +directory. + +The exception to +BR2_GLOBAL_PATCH_DIR+ being the preferred method for +specifying custom patches is +BR2_LINUX_KERNEL_PATCH+. ++BR2_LINUX_KERNEL_PATCH+ should be used to specify kernel patches that +are available at an URL. *Note:* +BR2_LINUX_KERNEL_PATCHES+ are applied +after patches available in +BR2_GLOBAL_PATCH_DIR+, as it is done +from a post-patch hook of the Linux package + +An example directory structure for where a user has multiple +directories specified for +BR2_GLOBAL_PATCH_DIR+ may look like this: + +----- +board/ ++-- common-fooarch +| +-- patches +| +-- linux +| | +-- linux-patch1.patch +| | +-- linux-patch2.patch +| +-- u-boot +| +-- foopkg ++-- fooarch-board + +-- patches + +-- linux + | +-- linux-patch3.patch + +-- u-boot + +-- foopkg +----- + +If the user has the +BR2_GLOBAL_PATCH_DIR+ configuration option set as +follows: + +----- +BR2_GLOBAL_PATCH_DIR="board/common-fooarch board/fooarch-board" +----- + +Then the patches would applied as follows for the Linux kernel: + +. board/common-fooarch/patches/linux/linux-patch1.patch +. board/common-fooarch/patches/linux/linux-patch2.patch +. board/fooarch-board/patches/linux/linux-patch3.patch
docs/manual/patch-policy.txt +13 -7
@@ -50,10 +50,11 @@ Global patch directory ^^^^^^^^^^^^^^^^^^^^^^ The +BR2_GLOBAL_PATCH_DIR+ configuration file option can be -used to specify a directory containing global package patches. See -xref:packages-custom[] for details. - +used to specify a space separated list of one or more directories +containing global package patches. See xref:packages-custom[] for +details. +[[patch-apply-order]] How patches are applied ~~~~~~~~~~~~~~~~~~~~~~~
@@ -64,19 +65,24 @@ How patches are applied . If +<packagename>_PATCH+ is defined, then patches from these tarballs are applied; -. If there are some +*.patch+ files in the package directory or in the - a package subdirectory named +<packageversion>+, then: +. If there are some +*.patch+ files in the package's Buildroot + directory or in a package subdirectory named +<packageversion>+, + then: + * If a +series+ file exists in the package directory, then patches are applied according to the +series+ file; + * Otherwise, patch files matching +<packagename>-*.patch+ are applied in alphabetical order. - So, to ensure they are applied in the right order, it is hightly - recommended to named the patch files like this: + So, to ensure they are applied in the right order, it is highly + recommended to name the patch files like this: +<packagename>-<number>-<description>.patch+, where +<number>+ refers to the 'apply order'. +. If +BR2_GLOBAL_PATCH_DIR+ is defined, the directories will be + enumerated in the order they are specified. The patches are applied + as described in the previous step. + . Run the +<packagename>_POST_PATCH_HOOKS+ commands if defined. If something goes wrong in the steps _3_ or _4_, then the build fails.
Signature · 1 line
1.7.9.5
PATCH v6 2/2 manual: update for multiple global patch dirs
Hi Ryan, Peter,
Quoted 32 lines · Ryan Barnett
Updating the documentation to reflect that multiple directories can now be specified for
BR2_GLOBAL_PATCH_DIR. Along with giving an example use case of how to use multiple global patch directories.Signed-off-by Ryan Barnett <[email protected]>Cc Thomas De Schampheleire <[email protected]>Cc Arnout Vandecappelle <[email protected]>---
Changes v4 -> v6:
- Minor wording that was missed from feedback received by Thomas D in v4.Changes v4 -> v5:
- Fixed minor wording issue and spelling (suggested by Thomas D)Changes v3 -> v4:
- Fixed minor spelling mistakes and wording (suggested by Arnout)
- Reword section about order that patches are applied along with making it clearer about when to useBR2_GLOBAL_PATCH_DIR(suggested by Arnout)Changes v2 -> v3:
- NoneChanges v1 -> v2:
- Fixed minor spelling mistakes and wording (suggested by Thomas D)--- docs/manual/customize-packages.txt | 92 ++++++++++++++++++++++++++++++++---- docs/manual/patch-policy.txt | 20 +++++--- 2 files changed, 96 insertions(+), 16 deletions(-)
[..]
docs/manual/customize-packages.txt It is sometimes useful to apply 'extra' patches to packages - over and · line 64
Quoted 7 lines
docs/manual/customize-packages.txt +7
-0+ +The exception to +BR2_GLOBAL_PATCH_DIR+ being the preferred method for +specifying custom patches is +BR2_LINUX_KERNEL_PATCH+. ++BR2_LINUX_KERNEL_PATCH+ should be used to specify kernel patches that +are available at an URL. *Note:* +BR2_LINUX_KERNEL_PATCHES+ are applied +after patches available in +BR2_GLOBAL_PATCH_DIR+, as it is done +from a post-patch hook of the Linux package
I'd add a dot here at the end of the sentence, but this is maybe something Peter can do while committing?
Other than that, finally: ;)
Best regards,
Thomas
PATCH v6 1/2 Support for multiple BR2_GLOBAL_PATCH_DIR
In reply to Ryan BarnettDear Ryan Barnett,
Quoted 8 lines · Ryan Barnett
Adding support for specifying multiple directories in
BR2_GLOBAL_PATCH_DIR. This will allow for a layered approach for the patching of a package.Signed-off-by Ryan Barnett <[email protected]>Cc Thomas De Schampheleire <[email protected]>Cc Arnout Vandecappelle <[email protected]>Reviewed-by Thomas De Schampheleire <[email protected]>
Both patches applied, thanks. On the second patch, I did the fix for the minor typo noticed by Thomas DS.
Thanks!
Thomas
Signature · 3 lines
Thomas Petazzoni, CTO, Free Electrons Embedded Linux, Kernel and Android engineering http://free-electrons.com