From cc15137adddb4b64989de2991e0780a541f2b6a0 Mon Sep 17 00:00:00 2001 From: Hauke Petersen Date: Mon, 28 Aug 2017 12:14:27 +0200 Subject: [PATCH 1/2] doc: added LOSTANDFOUND.md Added means to document (temporarily) removed features. The file contains a list of all modules/features that were removed for various reasons (typically: not maintained anymore), so that these can be reintegrated in a later point of time. --- LOSTANDFOUND.md | 57 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 57 insertions(+) create mode 100644 LOSTANDFOUND.md diff --git a/LOSTANDFOUND.md b/LOSTANDFOUND.md new file mode 100644 index 0000000000..633dafe0c4 --- /dev/null +++ b/LOSTANDFOUND.md @@ -0,0 +1,57 @@ +# Removed Features and Modules + +This document contains a listing of all features and modules that were removed +from RIOT at some point in time, mostly due to missing maintenance. The purpose +of this list is to have a reference point for reintegrating those features in +the future, if new interest arises or a new maintainer is found. + +This list is **not** supposed to contain a change log of all the things that are +being removed from RIOT, but it should contain only full modules that are +removed without any alternative being merged at the same time. For example +things like the first `netdev` should not be put in this list, as a successor +(former `netdev2`) has been merged. + + +## How to read this list + +For each high-level feature removed there should be one entry in this list. The +entries should comply to the following template: + +~~~~~~~~~~~~~~~~~~~ {.md} +### path/feature_name [HASH of removal commit] +Author(s): +- author 1 +- author 2 + +Reason for removal: +- give a short and comprehensive argumentation why this feature was removed +- typical reasons are: +- feature is not maintained anymore +- lack of hardware so feature can not be tested (anymore) +- feature was never used and there is no reason for keeping it +~~~~~~~~~~~~~~~~~~~ + +By putting the name of the removed feature and the commit hash in the same line, +one can very quickly find the commit using `get grep`. + +Listing the authors of the removed code is done for appreciation of their work. +This way, there names are never removed from the RIOT repository. + + +# Removed Features + +### boards/weio [cfa9580f319508f858c8fe30ecce8b2b59b6caa3] +Author(s): +- Paul Rathgeb + +Reason for removal: +- hardware not available to the community for testing +- original author and maintainer won't be able to maintain the code + +### cpu/lpc11u34 [7bc271807cecbffbb01a37c56a367b98fb823573] +Author(s): +- Paul Rathgeb + +Reason for removal: +- hardware not available to the community for testing +- original author and maintainer won't be able to maintain the code From 627596eeced002ad87b1276afdb778c40c65ef8c Mon Sep 17 00:00:00 2001 From: Hauke Petersen Date: Fri, 1 Sep 2017 09:33:01 +0200 Subject: [PATCH 2/2] doxygen: added removed feature document as page --- doc/doxygen/riot.doxyfile | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/doxygen/riot.doxyfile b/doc/doxygen/riot.doxyfile index 493c165c5a..91cc2bce24 100644 --- a/doc/doxygen/riot.doxyfile +++ b/doc/doxygen/riot.doxyfile @@ -765,7 +765,8 @@ INPUT = ../../doc.txt \ src/creating-modules.md \ src/creating-an-application.md \ src/getting-started.md \ - src/changelog.md + src/changelog.md \ + ../../LOSTANDFOUND.md # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses