Skip to content

doc: add page about creating modules#4480

Merged
Lotterleben merged 1 commit intoRIOT-OS:masterfrom
miri64:doc/enh/creating-modules
Dec 19, 2015
Merged

doc: add page about creating modules#4480
Lotterleben merged 1 commit intoRIOT-OS:masterfrom
miri64:doc/enh/creating-modules

Conversation

@miri64
Copy link
Copy Markdown
Member

@miri64 miri64 commented Dec 15, 2015

Moar doc :-)

@miri64 miri64 added Area: doc Area: Documentation DocTF labels Dec 15, 2015
@miri64 miri64 added this to the Release 2015.12 milestone Dec 15, 2015
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

if need to be

Stumbled upon that. How about "if there is a need for it" or similar

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

+1, also “if need be” seems more concise to me.

@PeterKietzmann
Copy link
Copy Markdown
Member

I think it could be interesting to inform that the Makefile.dep handles some modules dependencies.

@PeterKietzmann
Copy link
Copy Markdown
Member

Again: Thanks Martine :-) !

@Lotterleben
Copy link
Copy Markdown
Member

Would it make sense to add a short sentence about what Modules actually are, maybe something along the lines of “Modules add a specific set of features to the RIOT base kernel” (or something o.o) or is that out of place here?

@miri64
Copy link
Copy Markdown
Member Author

miri64 commented Dec 15, 2015

They do not add to the kernel, but I can try to formulate a description:

Modules in RIOT are well-defined units of code that provide a set of features to your application.

@OlegHahm OlegHahm mentioned this pull request Dec 15, 2015
24 tasks
@Lotterleben
Copy link
Copy Markdown
Member

True. I like that sentence. :)

@miri64 miri64 force-pushed the doc/enh/creating-modules branch from 18d89cd to 1e660db Compare December 16, 2015 21:56
@miri64
Copy link
Copy Markdown
Member Author

miri64 commented Dec 16, 2015

Rebased and addressed comments (added section about definition of modules including clarifications that drivers and to an extend CPU and board ports [disclaimer: can someone like @haukepetersen fact-prove that ;-)] are modules, too; added section about Makefile.dep)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I think it should be "to a certain extent"

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Fixed

@miri64
Copy link
Copy Markdown
Member Author

miri64 commented Dec 18, 2015

Fixed more comments. Now let's merge this so I can open a last minute release PR ;-)

@Lotterleben
Copy link
Copy Markdown
Member

ACK :) Could you squash please?

@miri64 miri64 force-pushed the doc/enh/creating-modules branch from 9170f3c to b5f5f83 Compare December 19, 2015 13:18
@miri64
Copy link
Copy Markdown
Member Author

miri64 commented Dec 19, 2015

Squashed.

@miri64 miri64 added CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR Process: needs backport Integration Process: The PR is required to be backported to a release or feature branch labels Dec 19, 2015
Lotterleben added a commit that referenced this pull request Dec 19, 2015
@Lotterleben Lotterleben merged commit 1ac9a0d into RIOT-OS:master Dec 19, 2015
@miri64 miri64 deleted the doc/enh/creating-modules branch December 19, 2015 13:30
@cgundogan cgundogan removed the Process: needs backport Integration Process: The PR is required to be backported to a release or feature branch label Apr 15, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Area: doc Area: Documentation CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants