doc: add page about creating modules #4480
Conversation
| Pseudomodules are modules that do not have any code. Their main use cases are | ||
| to provide base information for dependencies to other modules or information to | ||
| the code base via the `MODULE_<MODULENAME>` macro. Pseudomodules can provide | ||
| header files too, if need be. To create a pseudomodule just add its name to the |
There was a problem hiding this comment.
if need to be
Stumbled upon that. How about "if there is a need for it" or similar
There was a problem hiding this comment.
"if need be" is a correct phrasing: http://www.oxforddictionaries.com/de/definition/englisch/if-need-be
There was a problem hiding this comment.
+1, also “if need be” seems more concise to me.
|
I think it could be interesting to inform that the Makefile.dep handles some modules dependencies. |
|
Again: Thanks Martine :-) ! |
|
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? |
|
They do not add to the kernel, but I can try to formulate a description:
|
|
True. I like that sentence. :) |
18d89cd to
1e660db
Compare
|
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 |
| Creating modules {#creating-modules} | ||
| ================ | ||
| Modules in RIOT are well-defined units of code that provide a set of features | ||
| to your application. This includes also drivers and to a further extend ports |
There was a problem hiding this comment.
I think it should be "to a certain extent"
|
Fixed more comments. Now let's merge this so I can open a last minute release PR ;-) |
|
ACK :) Could you squash please? |
9170f3c to
b5f5f83
Compare
|
Squashed. |
doc: add page about creating modules
Moar doc :-)