From e5d234e2f497bcf856226b446e02fbeb4fd96dfd Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ga=C3=ABtan=20Harter?= <gaetan.harter@fu-berlin.de>
Date: Thu, 1 Mar 2018 14:06:28 +0100
Subject: [PATCH] doc: add warning that MODULE name should be unique
Modules produce an output archive called `${MODULE}.a` if several modules use
the same name, the output is overwritten.
---
doc/doxygen/src/creating-modules.md | 14 ++++++++++++++
1 file changed, 14 insertions(+)
diff --git a/doc/doxygen/src/creating-modules.md b/doc/doxygen/src/creating-modules.md
index 63d2c840d6..82d54be000 100644
--- a/doc/doxygen/src/creating-modules.md
+++ b/doc/doxygen/src/creating-modules.md
@@ -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
--
GitLab