RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Code Releases Activity

doc: add warning that MODULE name should be unique

Browse Source 
Modules produce an output archive called `${MODULE}.a` if several modules use
the same name, the output is overwritten.
This commit is contained in:
Gaëtan Harter 2018-03-01 14:06:28 +01:00
parent 7c85e6e0e9
commit e5d234e2f4
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/doxygen/src/creating-modules.md
View File

@ -34,6 +34,20 @@ current configuration or not.
Modules can be used by adding their name to the `USEMODULE` macro of your
application's Makefile.
### Pitfalls ###
The `MODULE` name should be unique or build breaks as modules overwrite the
same output file.
This problem happened in the past for:
* Packages root directory (libfixmath/u8g2)
* boards/cpu/periph and their common boards/cpu/periph
Note: even if all boards and cpus implement the `board` and `cpu` modules, only
one is used in an application so there is no conflict.
Module dependencies
===================
Your module may depend on other modules to minimize code duplication. These