Buildsystem: Introduce Global Makefiles for boards Directory
#21327
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
11cfaa5 to
df30029
Compare
mguetschow
reviewed
Mar 26, 2025
mguetschow
reviewed
Mar 26, 2025
c646f8a to
3f2aa15
Compare
071a53b to
b7e42ed
Compare
|
Squashed and documentation added. Thank you for reviewing :) |
mguetschow
reviewed
Mar 27, 2025
doc/doxygen/src/porting-boards.md
Outdated
| @@ -330,6 +351,20 @@ FEATURES_PROVIDED += periph_uart | |||
| include $(RIOTBOARD)/common/foo_common/Makefile.features | |||
| ``` | |||
|
|
|||
| If the common code includes source files or headers, it might be necessary | |||
There was a problem hiding this comment.
Suggested change
| If the common code includes source files or headers, it might be necessary | |
| If the common code includes source files, it might be necessary |
headers would have to go into Makefile.include, right?
There was a problem hiding this comment.
Yes. My thinking was that the make system won't even look at the directory at all without the DIRS +=, but in the old style, the Makefile.include was always added with an include statement, so the remark about the headers is redundant.
|
Successfully tested on |
b7e42ed to
76af091
Compare
mguetschow
approved these changes
Mar 27, 2025
|
@mguetschow thank you for working with me on this :) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Contribution description
Many boards in RIOT (such as the feather-nrf52840, feather-m0, ...) use common board definitions for things like the bootloader. Back when this was implemented in #8058, the approach was to include the directory by adding the path to the DIRS variable and setting the USEMODULE in one of the common folders.
This is not really elegant and the Makefile in the boards/common/... subfolder didn't even get executed.
You can find more information about this in #21298.
The original approach from #21299 was to automatically add the directories based on the
USEMODULEname, for example add the directoryboards/common/adafruit-nrf52-bootloaderwhen usingUSEMODULE += boards_common_adafruit-nrf52-bootloader.This might have unintended side effects since this was not originally intended, so the proposal from @mguetschow from #21299 (comment) was chosen.
This PR therefore introduces the new Makefiles
boards/Makefile,boards/Makefile.include,boards/Makefile.depandboards/Makefile.featuresto automatically include the right Makefiles when using certain modules.For example in the current master when using the
boards/common/adafruit-nrf52-bootloadercommon folder, you have to explicitly add the directory in yourboard/myboard/Makefile, add the commonMakefile.includein yourboard/myboard/Makefile.includeand add the commonMakefile.depin yourboard/myboard/Makefile.dep.With this PR, this is not necessary anymore because these includes are done in the
boards/Makefile{,.features,.include,.dep}files now.This approach would also work for the
cpu/subfolder, but for the time being I'd like to do this step by step (not looking at you #21299 👀).TODO: I would like to extend the
Porting Boardsdocumentation to include information about common board modules and how to use (and possibly even how to create) them.Testing procedure
Make sure the boards still compile and the common folder is still included.
Compilation of tests/sys/shell for the seeedstudio-xiao-nrf52840 on master:
Compilation of tests/sys/shell for the seeedstudio-xiao-nrf52840 with this PR:
Issues/PRs references
Fixes #21298.
Alternative approach for #21299.