Skip to content

drivers: remove drivers/Makefile.include and add driver specific Makefile.include#14369

Merged
benpicco merged 4 commits intoRIOT-OS:masterfrom
aabadie:pr/drivers/makefile_include
Jul 15, 2020
Merged

drivers: remove drivers/Makefile.include and add driver specific Makefile.include#14369
benpicco merged 4 commits intoRIOT-OS:masterfrom
aabadie:pr/drivers/makefile_include

Conversation

@aabadie
Copy link
Copy Markdown
Contributor

@aabadie aabadie commented Jun 26, 2020

Contribution description

This PR add Makefile.include in each driver modules when necessary and removes the main drivers/Makefile.include one. Each Makefile.include file is included automatically based on the content of the USEMODULE variable, similar to what is done with USEPKG for packages.

Testing procedure

  • A green Murdock should be enough

Issues/PRs references

Some documentation is added to the driver guide, so this fixes #14330.
There was an initial effort in this direction provided by #6923, which is partially addressed by this PR.

@aabadie aabadie added Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation Area: build system Area: Build system Area: drivers Area: Device drivers labels Jun 26, 2020
@aabadie aabadie added the Discussion: RFC The issue/PR is used as a discussion starting point about the item of the issue/PR label Jun 26, 2020
@aabadie
Copy link
Copy Markdown
Contributor Author

aabadie commented Jun 26, 2020

Note that with this PR, it will be easy for riotgen to generate a working driver module. cc @HendrikVE

@gschorcht gschorcht mentioned this pull request Jun 26, 2020
Merged
benpicco
benpicco reviewed Jun 26, 2020
View reviewed changes
@aabadie aabadie force-pushed the pr/drivers/makefile_include branch from 780afbb to 0b62120 Compare June 26, 2020 14:06
@aabadie aabadie added the CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR label Jun 26, 2020
@aabadie
Copy link
Copy Markdown
Contributor Author

aabadie commented Jun 26, 2020

I have a version of this PR for per driver dependency resolution. Will PR it soon.

@aabadie aabadie mentioned this pull request Jun 29, 2020
Merged
@aabadie aabadie force-pushed the pr/drivers/makefile_include branch from 0b62120 to 49b0634 Compare June 29, 2020 09:00
@benpicco
Copy link
Copy Markdown
Contributor

benpicco commented Jun 29, 2020

Looks good, please squash!
@miri64 can this still go in during the soft feature freeze?

@aabadie
Copy link
Copy Markdown
Contributor Author

aabadie commented Jun 29, 2020

please squash!

Wait a bit, I have to update the driver guide before :)

@aabadie aabadie force-pushed the pr/drivers/makefile_include branch from f35c25d to 8110507 Compare June 29, 2020 15:32
@miri64
Copy link
Copy Markdown
Member

miri64 commented Jun 29, 2020

@miri64 can this still go in during the soft feature freeze?

If you have to ask this question, I rather don't want to risk it. The PR looks simple enough on one hand, on the other it changes quite a bit of the drivers module's include path within the build system.

@aabadie aabadie force-pushed the pr/drivers/makefile_include branch from 8110507 to f0a5106 Compare June 29, 2020 17:04
fjmolinas
fjmolinas previously requested changes Jun 30, 2020
View reviewed changes
Copy link
Copy Markdown
Contributor

@fjmolinas fjmolinas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@miri64 preferred having this one delayed till after hard feature freeze, so blocking until then.

@aabadie aabadie force-pushed the pr/drivers/makefile_include branch from f0a5106 to c487f38 Compare July 10, 2020 14:23
@benpicco
Copy link
Copy Markdown
Contributor

benpicco commented Jul 10, 2020

@aabadie feel free to squash
Now that the release has branched off, I'd rather merge this soon before more merge conflicts pop up.

@aabadie aabadie force-pushed the pr/drivers/makefile_include branch from b906222 to 6deb809 Compare July 10, 2020 15:24
@benpicco benpicco dismissed fjmolinas’s stale review July 15, 2020 15:31

Hard Feature Freeze is over

@benpicco
Copy link
Copy Markdown
Contributor

benpicco commented Jul 15, 2020

(sorry, meant to write soft feature freeze)

@benpicco benpicco added CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR and removed CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR labels Jul 15, 2020
benpicco
benpicco approved these changes Jul 15, 2020
View reviewed changes
Copy link
Copy Markdown
Contributor

@benpicco benpicco left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If Murdock still likes this, we should merge this now IMHO.

@aabadie aabadie force-pushed the pr/drivers/makefile_include branch from 6deb809 to 628777f Compare July 15, 2020 18:36
@aabadie
Copy link
Copy Markdown
Contributor Author

aabadie commented Jul 15, 2020

rebased, let's see if Murdock is still green.

@benpicco
Copy link
Copy Markdown
Contributor

benpicco commented Jul 15, 2020

Murdock does a rebase already 😉

@benpicco benpicco merged commit 2331f9a into RIOT-OS:master Jul 15, 2020
@aabadie aabadie deleted the pr/drivers/makefile_include branch July 16, 2020 06:56
@PeterKietzmann PeterKietzmann mentioned this pull request Aug 26, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@benpicco benpicco benpicco approved these changes

@fjmolinas fjmolinas fjmolinas left review comments

@basilfx basilfx Awaiting requested review from basilfx basilfx is a code owner

@bergzand bergzand Awaiting requested review from bergzand bergzand is a code owner

@daniel-k daniel-k Awaiting requested review from daniel-k

@gschorcht gschorcht Awaiting requested review from gschorcht gschorcht is a code owner

@haukepetersen haukepetersen Awaiting requested review from haukepetersen

@jia200x jia200x Awaiting requested review from jia200x jia200x is a code owner

@leandrolanzieri leandrolanzieri Awaiting requested review from leandrolanzieri leandrolanzieri is a code owner

@maribu maribu Awaiting requested review from maribu maribu is a code owner

@miri64 miri64 Awaiting requested review from miri64 miri64 is a code owner

@smlng smlng Awaiting requested review from smlng

Assignees

No one assigned

Labels

Area: build system Area: Build system Area: drivers Area: Device drivers CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR Discussion: RFC The issue/PR is used as a discussion starting point about the item of the issue/PR Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Improve driver implementation documentation

4 participants

@aabadie @benpicco @miri64 @fjmolinas