Merge pull request RIOT-OS#12389 from miri64/pkg/depr/emb6

emb6: deprecate package
OlegHahm · Oct 9, 2019 · 3e0a3b1 · 3e0a3b1
2 parents 238ebe3 + 7cf1bab
commit 3e0a3b1
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 3 deletions.
diff --git a/doc/doxygen/riot.doxyfile b/doc/doxygen/riot.doxyfile
@@ -828,7 +828,6 @@ EXCLUDE_PATTERNS       = */board/*/tools/* \
                          */cpu/native/osx-libc-extra \
                          */cpu/x86/include/* \
                          */drivers/kw2xrf/include/overwrites.h \
-                         */pkg/emb6/* \
                          */pkg/lwip/* \
                          */pkg/tlsf/patch.txt \
                          */sys/include/embUnit/* \

diff --git a/pkg/emb6/doc.txt b/pkg/emb6/doc.txt
@@ -5,6 +5,10 @@
  * @brief    emb6 network stack
  * @see      https://github.com/hso-esk/emb6/blob/14e4a3cfff01644e078870e14e16a1fe60dcc895/doc/pdf/emb6.pdf
  *
+ * @deprecated  Based on very old version of `emb6` and the package is
+ *              basically unmaintained; will be removed after the 2020.07
+ *              release.
+ *
  * emb6 is a fork of Contiki's uIP network stack without its usage of
  * proto-threads. It uses periodic event polling instead.
  */
diff --git a/pkg/emb6/include/board_conf.h b/pkg/emb6/include/board_conf.h
@@ -7,8 +7,7 @@
  */
 
 /**
- * @defgroup    emb6    emb6 network stack
- * @ingroup pkg
+ * @addtogroup  pkg_emb6
  * @brief
  * @{
  *

diff --git a/pkg/emb6/include/sock_types.h b/pkg/emb6/include/sock_types.h
@@ -33,6 +33,9 @@
 extern "C" {
 #endif
 
+/**
+ * @brief   Size for struct sock_udp::mbox_queue
+ */
 #ifndef SOCK_MBOX_SIZE
 #define SOCK_MBOX_SIZE  (2)
 #endif