doc/guides/finding_modules: make inclusion clearer#22485
Open
AnnsAnns wants to merge 1 commit into
Open
Conversation
AnnsAnns
added
CI: ready for build
crasbe
added
the
Type: enhancement
crasbe
reviewed
Jul 19, 2026
Comment on lines
+93
to
+95
| Make sure to always include stuff before `include $(RIOTBASE)/Makefile.include` in your `Makefile`. | ||
| This is important because the `Makefile.include` file will do a lot of build system setup | ||
| and doing it after that will not work as expected and cause confusing errors. |
Contributor
There was a problem hiding this comment.
Suggested change
| Make sure to always include stuff before `include $(RIOTBASE)/Makefile.include` in your `Makefile`. | |
| This is important because the `Makefile.include` file will do a lot of build system setup | |
| and doing it after that will not work as expected and cause confusing errors. | |
| Make sure that `include $(RIOTBASE)/Makefile.include` is the very last line in your `Makefile`. | |
| This is important because the `Makefile.include` file is responsible for setting up the | |
| build process and kicks off the dependency resolution. Everything included and defined | |
| after this line will not be considered by this process and therefore will either | |
| not work at all, not work as expected and/or cause confusing errors. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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
After somebody new to RIOT tried to include a package following the tutorial, they assumed that it can be anywhere within the Makefile (which, to be fair, the guide also never make clear before). Naturally the build system gets really confused because the package will never be resolved. This should hopefully stop that from happening in the future (if people read the guide :P)
Testing procedure
read text
Issues/PRs references
Declaration of AI-Tools / LLMs usage:
AI-Tools / LLMs that were used are: