mirror of
https://github.com/RIOT-OS/RIOT.git
synced 2026-01-01 01:41:18 +01:00
doc: standardize capitalizations and fix urls
This commit is contained in:
Lasse Rosenow
parent
996f97c134
commit
f5b814437c
@ -15,12 +15,12 @@ We rather would like you to think of it as a guide to enrich our community and
|
||||
the technical community in general with new knowledge and perspectives by
|
||||
allowing everyone to participate.
|
||||
|
||||
This code of conduct applies to all spaces managed by the RIOT community. This
|
||||
This Code of Conduct applies to all spaces managed by the RIOT community. This
|
||||
includes any communication within the RIOT community, both online and face to
|
||||
face. In addition, violations of this code outside these spaces may also
|
||||
affect a person's ability to participate within them.
|
||||
|
||||
If you believe someone is violating the code of conduct, we ask that you report
|
||||
If you believe someone is violating the Code of Conduct, we ask that you report
|
||||
it by emailing <conduct@riot-os.org>. For more details please see our [Reporting
|
||||
Guidelines][reporting-guidelines].
|
||||
|
||||
|
||||
@ -1,12 +1,15 @@
|
||||
You should check out the [C Conventions](CODING_CONVENTIONS.md) as some section
|
||||
# Coding Conventions C++
|
||||
|
||||
You should check out the [C Conventions] as some section
|
||||
still apply (Documentation, Git, Travis).
|
||||
|
||||
When contributing source code, please adhere to the following coding style,
|
||||
which is loosely based on the [Google C++ Style Guide] and the coding
|
||||
conventions used by the C++ Standard Library. Based on the [CAF coding style].
|
||||
|
||||
[Google C++ Style Guide]: (https://google.github.io/styleguide/cppguide.html)
|
||||
[CAF coding style]: (https://github.com/actor-framework/actor-framework/blob/master/CONTRIBUTING.md)
|
||||
[C Conventions]: https://guide.riot-os.org/c_tutorials/coding_conventions/
|
||||
[Google C++ Style Guide]: https://google.github.io/styleguide/cppguide.html
|
||||
[CAF coding style]: https://github.com/actor-framework/actor-framework/blob/master/CONTRIBUTING.md
|
||||
|
||||
## Example for the Impatient
|
||||
|
||||
@ -233,7 +236,6 @@ void my_class::do_something_else() {
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
## Headers
|
||||
|
||||
- Each `.cpp` file has an associated `.hpp` file.
|
||||
@ -258,7 +260,6 @@ void my_class::do_something_else() {
|
||||
|
||||
- Use `inline` for small functions (rule of thumb: 10 lines or less).
|
||||
|
||||
|
||||
## Breaking Statements
|
||||
|
||||
- Break constructor initializers after the comma, use four spaces for
|
||||
@ -295,7 +296,6 @@ void my_class::do_something_else() {
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
## Template Metaprogramming
|
||||
|
||||
Despite its power, template metaprogramming came to the language pretty
|
||||
@ -340,7 +340,6 @@ extra rules for formatting metaprogramming code.
|
||||
ResponseHandleTag>;
|
||||
```
|
||||
|
||||
|
||||
## Preprocessor Macros
|
||||
|
||||
- Use macros if and only if you can't get the same result by using inline
|
||||
@ -348,7 +347,6 @@ extra rules for formatting metaprogramming code.
|
||||
|
||||
- Macro names use the form `RIOT_<COMPONENT>_<NAME>`.
|
||||
|
||||
|
||||
## Comments
|
||||
|
||||
- Doxygen comments start with `///`.
|
||||
|
||||
@ -257,7 +257,7 @@ Computing Foundation (CNCF).
|
||||
[contributing guidelines]: https://github.com/RIOT-OS/RIOT/blob/master/CONTRIBUTING.md
|
||||
[maintainers list]: https://riot-os.org/maintainers.html
|
||||
[maintainers GitHub team]: https://github.com/orgs/RIOT-OS/teams/maintainers
|
||||
[managing a release]: https://github.com/RIOT-OS/RIOT/blob/master/doc/guides/managing-a-release/README.md
|
||||
[managing a release]: https://guide.riot-os.org/misc/managing-a-release/
|
||||
[maintaining guidelines]: https://github.com/RIOT-OS/RIOT/blob/master/MAINTAINING.md
|
||||
[Code of Conduct]: https://guide.riot-os.org/general/code_of_conduct/
|
||||
[Code of Conduct reporting guidance]: https://guide.riot-os.org/general/code_of_conduct/reporting/
|
||||
|
||||
472
LOSTANDFOUND.md
472
LOSTANDFOUND.md
@ -11,13 +11,12 @@ 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:
|
||||
entries should be ordered alphabetically and comply to the following template:
|
||||
|
||||
~~~~~~~~~~~~~~~~~~~ {.md}
|
||||
```markdown
|
||||
### path/feature_name [HASH of removal commit]
|
||||
Author(s):
|
||||
- author 1 <foo.bar@abc.com>
|
||||
@ -29,7 +28,7 @@ Reason for removal:
|
||||
- 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
|
||||
~~~~~~~~~~~~~~~~~~~
|
||||
```
|
||||
|
||||
Additionally, a link reference for the commit on GitHub is added to the bottom of this document.
|
||||
|
||||
@ -39,273 +38,138 @@ one can very quickly find the commit using `git grep`.
|
||||
Listing the authors of the removed code is done for appreciation of their work.
|
||||
This way, their names are never removed from the RIOT repository.
|
||||
|
||||
|
||||
# Removed Features
|
||||
|
||||
### cpu/mips* [6cad5d24771ba6199228351a11b5062cd2e9b36d]
|
||||
|
||||
Author:
|
||||
- Neil Jones <Neil.Jones@imgtec.com>
|
||||
|
||||
Reasons for removal:
|
||||
- Not maintained anymore
|
||||
- Current state is not very useful and nobody claimed to use it
|
||||
|
||||
### pkg/libcoap [d83d08f0995a88f399e70a7d07b44dd780082436]
|
||||
|
||||
Author:
|
||||
- Martine Lenders <mlenders@inf.fu-berlin.de>
|
||||
|
||||
Reasons for removal:
|
||||
- Not maintained anymore, no updates for 8 years
|
||||
- Upstream libcoap allows building with RIOT, so there is a migration path for users
|
||||
|
||||
### sys/net/gnrc/nettest [cdc252ab7bd4161cc046bf93a3e55995704b24d4]
|
||||
Author:
|
||||
- Martine Lenders <mlenders@inf.fu-berlin.de>
|
||||
|
||||
Reasons for removal:
|
||||
- Not maintained anymore
|
||||
- Not used in GNRC
|
||||
## Removed Features
|
||||
|
||||
### boards/chronos [ed3887ac5c1e95308c2827bce3cdca8b0f146c22]
|
||||
|
||||
Author(s):
|
||||
|
||||
- Oliver Hahm <oliver.hahm@inria.fr>
|
||||
- Kaspar Schleiser <kaspar@schleiser.de>
|
||||
|
||||
Reason for removal:
|
||||
|
||||
- board is quite outdated
|
||||
- board cannot be automatically tested for lack of UART
|
||||
- board has many special cases, which hurt upgrade to msp430-elf-gcc 9.x
|
||||
- the onboard radio has been unsupported for a while
|
||||
- no one seems to use the board, no one seems to maintain it
|
||||
|
||||
### sys/net/gnrc/application_layer/tftp [0e2a62078850e1ecc74db2db4d639cf2d8fb96d3]
|
||||
Author:
|
||||
- DipSwitch <dipswitch@ownage4u.nl>
|
||||
### boards/fox [81458c8eed8949c686d5ded652dbee10748e860b]
|
||||
|
||||
Reasons for removal:
|
||||
- Not maintained anymore.
|
||||
- Existing quality and security defects.
|
||||
|
||||
### pkg/oonf_api [c829f820ee870bffc60c7df688d2da8373553212]
|
||||
Author:
|
||||
- Benjamin Valentin <benpicco@googlemail.com>
|
||||
|
||||
Reasons for removal:
|
||||
- Package has not been update since 2013.
|
||||
- Tests were never integrated to the CI.
|
||||
- NHDP, which was the only upstream user, has been removed.
|
||||
|
||||
### sys/net/routing/nhdp [9026823bb906f64168d7d38e52be92f390353dc8]
|
||||
Author:
|
||||
- Fabian Nack <nack@inf.fu-berlin.de>
|
||||
|
||||
Reasons for removal:
|
||||
- Not maintained anymore.
|
||||
- Does not comply with the current RIOT programming practices.
|
||||
|
||||
### sys/ubjson [bea30c3f8949ebd9fdf4a9bf0a987652889930f5]
|
||||
Author(s):
|
||||
- René Kijewski <rene.kijewski@fu-berlin.de>
|
||||
|
||||
Reasons for removal:
|
||||
- Unsafe code.
|
||||
- Did not comply with RIOT standards.
|
||||
- More standard alternatives available (such as CBOR).
|
||||
- Thomas Eichinger <thomas.eichinger@fu-berlin.de>
|
||||
|
||||
Reason for removal:
|
||||
|
||||
- Hardware not available so can't be tested
|
||||
|
||||
### boards/jiminy-mega256rfr2 [232aed3e18118624b862d36bfec7cd1c21ca2d26]
|
||||
|
||||
Author:
|
||||
|
||||
- Josua Arndt <jarndt@ias.rwth-aachen.de>
|
||||
- Steffen Robertz <steffen.robertz@rwth-aachen.de>
|
||||
|
||||
Reasons for removal:
|
||||
|
||||
- The board is a custom design at the RWTH Aachen, so only two persons have
|
||||
access to the hardware
|
||||
- It was unmaintained for several month now
|
||||
- Various refactoring PRs affected the ATmega CPU family have not been tested,
|
||||
it is unclear if the board is actually usable with RIOT
|
||||
|
||||
### cpu/mips32r2_generic [a2bcd7539ce1931b7aec0077ea71dadd62c96edd]
|
||||
Author:
|
||||
- Neil Jones <neil.jones@imgtec.com>
|
||||
|
||||
- No boards use this CPU (the only one was mips-malta).
|
||||
- (Same reasons as mips-malta)
|
||||
|
||||
### boards/mips-malta [ee6b6b9c388b78fcec7ba6e239a6c76041b9bbb7]
|
||||
|
||||
Author:
|
||||
|
||||
- Neil Jones <neil.jones@imgtec.com>
|
||||
|
||||
Reasons for removal:
|
||||
|
||||
- UART input not supported.
|
||||
- Hardware not available for testing and not available for purchase either.
|
||||
- Not actively maintained / broken for some time.
|
||||
|
||||
### boards/pca10000 [9447cb303426d7c6348bb84999f88bf929cd6263]
|
||||
### boards/nrf6310 [4953ba8e6759d2b1a1a1ea497a4ad1e71489195a]
|
||||
|
||||
Author(s):
|
||||
|
||||
- Christian Kühling <kuehling@zedat.fu-berlin.de>
|
||||
- Timo Ziegler <timo.ziegler@fu-berlin.de>
|
||||
- Hauke Petersen <hauke.petersen@fu-berlin.de>
|
||||
|
||||
Reason for removal:
|
||||
|
||||
- this was an early development board by Nordic which was discontinued
|
||||
(successor: `nrf51dk`)
|
||||
- also for a `BLE DEVKIT.N` board from Mommosoft, which was discontinued as well
|
||||
- no hardware available anymore for testing, many exclusions from CI
|
||||
|
||||
### boards/pca10000 [9447cb303426d7c6348bb84999f88bf929cd6263]
|
||||
|
||||
Author(s):
|
||||
|
||||
- Christian Kühling <kuehling@zedat.fu-berlin.de>
|
||||
- Timo Ziegler <timo.ziegler@fu-berlin.de>
|
||||
- Hauke Petersen <hauke.petersen@fu-berlin.de>
|
||||
|
||||
Reason for removal:
|
||||
|
||||
- this was an early development board by Nordic which was discontinued (successor: `nrf51dongle`)
|
||||
- no hardware available anymore for testing
|
||||
|
||||
### boards/pca10005 [ea73cc49eacd45640b9660134c4c92b887cb2716]
|
||||
|
||||
Author(s):
|
||||
|
||||
- Christian Kühling <kuehling@zedat.fu-berlin.de>
|
||||
- Timo Ziegler <timo.ziegler@fu-berlin.de>
|
||||
- Hauke Petersen <hauke.petersen@fu-berlin.de>
|
||||
|
||||
Reason for removal:
|
||||
|
||||
- this was an early development board by Nordic which was discontinued (successor: `nrf51dk`)
|
||||
- no hardware available anymore for testing
|
||||
|
||||
### boards/qemu-i386 [99009af25e201bbc182d376e99df34133417be6c]
|
||||
|
||||
Author(s):
|
||||
|
||||
- René Kijewski <rene.kijewski@fu-berlin.de>
|
||||
|
||||
Reason for removal:
|
||||
|
||||
- code broken and excluded from all tests for a long time
|
||||
- no maintainer available
|
||||
|
||||
### boards/weio [cfa9580f319508f858c8fe30ecce8b2b59b6caa3]
|
||||
Author(s):
|
||||
- Paul Rathgeb <paul.rathgeb@skynet.be>
|
||||
|
||||
Reason for removal:
|
||||
- hardware not available to the community for testing
|
||||
- original author and maintainer won't be able to maintain the code
|
||||
|
||||
### boards/x86-multiboot-common [b3eb9b8cf23f0702fa725d536df6ad6528f84189]
|
||||
Author(s):
|
||||
- René Kijewski <rene.kijewski@fu-berlin.de>
|
||||
|
||||
Reason for removal:
|
||||
- code broken and excluded from all tests for a long time
|
||||
- no maintainer available
|
||||
|
||||
|
||||
### cpu/lpc11u34 [7bc271807cecbffbb01a37c56a367b98fb823573]
|
||||
Author(s):
|
||||
- Paul Rathgeb <paul.rathgeb@skynet.be>
|
||||
|
||||
Reason for removal:
|
||||
- hardware not available to the community for testing
|
||||
- original author and maintainer won't be able to maintain the code
|
||||
|
||||
### cpu/x86 [fc45d7c5ac3d46bfdfb21c243cd3d4881bc5c836]
|
||||
Author(s):
|
||||
- René Kijewski <rene.kijewski@fu-berlin.de>
|
||||
|
||||
Reason for removal:
|
||||
- code broken and excluded from all tests for a long time
|
||||
- no maintainer available
|
||||
|
||||
### gnrc_pktbuf_duplicate_upto() [b83430aa625a1d42f11f9badf5e5cfbb8efacd99]
|
||||
Author(s):
|
||||
- Takuo Yonezawa <yonezawa.t2@gmail.com>
|
||||
- Martine S. Lenders <m.lenders@fu-berlin.de>
|
||||
|
||||
Reason for removal:
|
||||
- broke the abstraction of `gnrc_pktbuf`
|
||||
- its only user within the RIOT code base `gnrc_ipv6_ext` was reworked in
|
||||
[f671a87fe2c539c3aecd595ae03fa4f6f209d042] so it is not needed anymore.
|
||||
- the function was deprecated in [f2760c033c5f332be076b25aa212aca4007c3d65]
|
||||
|
||||
### boards/wsn430-v1_3b, boards/wsn430-v1_4 [e63cd54f3b1e002a7895bb7c46af889b341c1a15]
|
||||
|
||||
Author(s):
|
||||
- Hauke Petersen <hauke.petersen@fu-berlin.de>
|
||||
- Martine Lenders <m.lenders@fu-berlin.de>
|
||||
- Milan Babel <babel@inf.fu-berlin.de>
|
||||
- Oliver Hahm <oliver.hahm@inria.fr>
|
||||
|
||||
Reason for removal:
|
||||
- no longer accessible on the IoT-LAB testbed
|
||||
|
||||
### pkg/emb6 [4f243c52eabefe709d78560ce7f1d502d737a999]
|
||||
Author(s):
|
||||
- Martine S. Lenders <m.lenders@fu-berlin.de>
|
||||
|
||||
Reason for removal:
|
||||
- Stale upstream (last update to date in Mar 2018)
|
||||
- Ported version even older (last update Feb 2016)
|
||||
- Updating to more recent version would be more effort than its worth
|
||||
|
||||
### GNRC_NETTYPE_IOVEC [4f243c52eabefe709d78560ce7f1d502d737a999]
|
||||
Author(s):
|
||||
- Martine S. Lenders <m.lenders@fu-berlin.de>
|
||||
- Hauke Petersen <devel@haukepetersen.de>
|
||||
|
||||
Reason for removal:
|
||||
- Unused since [9fb2f541baca469e34fa01b004d6f19385700ce9]
|
||||
|
||||
### pkg/nordic_softdevice_ble [35b6ccedf31f10a5f8e4f97609ad5b10c28bdc34]
|
||||
Author(s):
|
||||
- Hauke Petersen <hauke.petersen@fu-berlin.de>
|
||||
- Kaspar Schleiser <kaspar@schleiser.de>
|
||||
- Martine Lenders <m.lenders@fu-berlin.de>
|
||||
- Wojciech Bober <wojciech.bober@nordicsemi.no>
|
||||
|
||||
Reason for removal:
|
||||
- Outdated, unmaintained and no longer working
|
||||
|
||||
### pkg/qdsa [cc357f9638ce22a39eab8f79055f1154388ccb74]
|
||||
Author(s):
|
||||
- Kaspar Schleiser <kaspar@schleiser.de> (integration into RIOT as package)
|
||||
- Joost Renes <joost.renes@nxp.com> (upstream code)
|
||||
|
||||
Reason for removal:
|
||||
- No users besides the test
|
||||
- The qDSA signature does not seem to have received the level of attention and
|
||||
scrutiny by the crypto community that would justify inclusion in a general
|
||||
purpose OS
|
||||
|
||||
### gnrc_pktbuf_replace_snip() [72821a502f073006643cb4ef7815fc8c42563ce6]
|
||||
Author(s):
|
||||
- Joakim Nohlgård <joakim.nohlgard@eistec.se>
|
||||
- Martine S. Lenders <m.lenders@fu-berlin.de>
|
||||
|
||||
Reason for removal:
|
||||
- Unused, untested and no longer needed
|
||||
|
||||
### sys/irq_handler [a2dd6f90e51ca9edef643ba72bd1fd18113cf0d2]
|
||||
Author(s):
|
||||
- Gunar Schorcht <gunar@schorcht.net>
|
||||
|
||||
Reason for removal:
|
||||
- Provides some feature as `sys/event_thread`
|
||||
- Has been deprecated directly in the first release it was provided
|
||||
|
||||
### boards/slwstk6220a [cab1ea66b49e3c72e2827c8686c09d84ae3ef9a9]
|
||||
|
||||
Author(s):
|
||||
|
||||
- Hauke Petersen <hauke.petersen@fu-berlin.de>
|
||||
- Bas Stottelaar <basstottelaar@gmail.com>
|
||||
|
||||
Reason for removal:
|
||||
|
||||
- The old implementation of the SLWSTK6220A based on `cpu/ezr32wg` did not use
|
||||
the Gecko SDK, that other EFM32-based boards do use
|
||||
- The old implementation had limited peripherals supported
|
||||
- New implementation (with the same name) that is based on `cpu/efm32` was
|
||||
added in commit [fe941ac9fe3f81c0f08ff3b8564cf439639abcda]
|
||||
|
||||
### boards/fox [81458c8eed8949c686d5ded652dbee10748e860b]
|
||||
Author(s):
|
||||
- Thomas Eichinger <thomas.eichinger@fu-berlin.de>
|
||||
|
||||
Reason for removal:
|
||||
- Hardware not available so can't be tested
|
||||
|
||||
### boards/waspmote-pro [2b8a0d48940517f7df4e78c7a0b16024f46a8694]
|
||||
|
||||
Author(s):
|
||||
|
||||
- Hinnerk van Bruinehsen
|
||||
- Kaspar Schleiser <kaspar@schleiser.de>
|
||||
- Francisco Acosta
|
||||
- J. David Ibáñez <jdavid.ibp@gmail.com>
|
||||
|
||||
Reason for removal:
|
||||
|
||||
- This board is sold only B2B, so that our community members from the
|
||||
DIY/hobbyist community and academia do not have access to the board. Our
|
||||
community members from the industry mostly develop their own hardware and,
|
||||
@ -313,17 +177,236 @@ therefore, have no interest in supporting this board. As result, none of the
|
||||
RIOT core contributors has access to the hardware, preventing us from doing the
|
||||
necessary testing for maintaining this board.
|
||||
|
||||
### boards/nrf6310 [4953ba8e6759d2b1a1a1ea497a4ad1e71489195a]
|
||||
### boards/weio [cfa9580f319508f858c8fe30ecce8b2b59b6caa3]
|
||||
|
||||
Author(s):
|
||||
- Christian Kühling <kuehling@zedat.fu-berlin.de>
|
||||
- Timo Ziegler <timo.ziegler@fu-berlin.de>
|
||||
- Hauke Petersen <hauke.petersen@fu-berlin.de>
|
||||
|
||||
- Paul Rathgeb <paul.rathgeb@skynet.be>
|
||||
|
||||
Reason for removal:
|
||||
- this was an early development board by Nordic which was discontinued
|
||||
(successor: `nrf51dk`)
|
||||
- also for a `BLE DEVKIT.N` board from Mommosoft, which was discontinued as well
|
||||
- no hardware available anymore for testing, many exclusions from CI
|
||||
|
||||
- hardware not available to the community for testing
|
||||
- original author and maintainer won't be able to maintain the code
|
||||
|
||||
### boards/wsn430-v1_3b, boards/wsn430-v1_4 [e63cd54f3b1e002a7895bb7c46af889b341c1a15]
|
||||
|
||||
Author(s):
|
||||
|
||||
- Hauke Petersen <hauke.petersen@fu-berlin.de>
|
||||
- Martine Lenders <m.lenders@fu-berlin.de>
|
||||
- Milan Babel <babel@inf.fu-berlin.de>
|
||||
- Oliver Hahm <oliver.hahm@inria.fr>
|
||||
|
||||
Reason for removal:
|
||||
|
||||
- no longer accessible on the IoT-LAB testbed
|
||||
|
||||
### boards/x86-multiboot-common [b3eb9b8cf23f0702fa725d536df6ad6528f84189]
|
||||
|
||||
Author(s):
|
||||
|
||||
- René Kijewski <rene.kijewski@fu-berlin.de>
|
||||
|
||||
Reason for removal:
|
||||
|
||||
- code broken and excluded from all tests for a long time
|
||||
- no maintainer available
|
||||
|
||||
### cpu/lpc11u34 [7bc271807cecbffbb01a37c56a367b98fb823573]
|
||||
|
||||
Author(s):
|
||||
|
||||
- Paul Rathgeb <paul.rathgeb@skynet.be>
|
||||
|
||||
Reason for removal:
|
||||
|
||||
- hardware not available to the community for testing
|
||||
- original author and maintainer won't be able to maintain the code
|
||||
|
||||
### cpu/mips32r2_generic [a2bcd7539ce1931b7aec0077ea71dadd62c96edd]
|
||||
|
||||
Author:
|
||||
|
||||
- Neil Jones <neil.jones@imgtec.com>
|
||||
|
||||
- No boards use this CPU (the only one was mips-malta).
|
||||
- (Same reasons as mips-malta)
|
||||
|
||||
### cpu/mips* [6cad5d24771ba6199228351a11b5062cd2e9b36d]
|
||||
|
||||
Author:
|
||||
|
||||
- Neil Jones <Neil.Jones@imgtec.com>
|
||||
|
||||
Reasons for removal:
|
||||
|
||||
- Not maintained anymore
|
||||
- Current state is not very useful and nobody claimed to use it
|
||||
|
||||
### cpu/x86 [fc45d7c5ac3d46bfdfb21c243cd3d4881bc5c836]
|
||||
|
||||
Author(s):
|
||||
|
||||
- René Kijewski <rene.kijewski@fu-berlin.de>
|
||||
|
||||
Reason for removal:
|
||||
|
||||
- code broken and excluded from all tests for a long time
|
||||
- no maintainer available
|
||||
|
||||
### GNRC_NETTYPE_IOVEC [4f243c52eabefe709d78560ce7f1d502d737a999]
|
||||
|
||||
Author(s):
|
||||
|
||||
- Martine S. Lenders <m.lenders@fu-berlin.de>
|
||||
- Hauke Petersen <devel@haukepetersen.de>
|
||||
|
||||
Reason for removal:
|
||||
|
||||
- Unused since [9fb2f541baca469e34fa01b004d6f19385700ce9]
|
||||
|
||||
### gnrc_pktbuf_duplicate_upto() [b83430aa625a1d42f11f9badf5e5cfbb8efacd99]
|
||||
|
||||
Author(s):
|
||||
|
||||
- Takuo Yonezawa <yonezawa.t2@gmail.com>
|
||||
- Martine S. Lenders <m.lenders@fu-berlin.de>
|
||||
|
||||
Reason for removal:
|
||||
|
||||
- broke the abstraction of `gnrc_pktbuf`
|
||||
- its only user within the RIOT code base `gnrc_ipv6_ext` was reworked in
|
||||
[f671a87fe2c539c3aecd595ae03fa4f6f209d042] so it is not needed anymore.
|
||||
- the function was deprecated in [f2760c033c5f332be076b25aa212aca4007c3d65]
|
||||
|
||||
### gnrc_pktbuf_replace_snip() [72821a502f073006643cb4ef7815fc8c42563ce6]
|
||||
|
||||
Author(s):
|
||||
|
||||
- Joakim Nohlgård <joakim.nohlgard@eistec.se>
|
||||
- Martine S. Lenders <m.lenders@fu-berlin.de>
|
||||
|
||||
Reason for removal:
|
||||
|
||||
- Unused, untested and no longer needed
|
||||
|
||||
### pkg/emb6 [4f243c52eabefe709d78560ce7f1d502d737a999]
|
||||
|
||||
Author(s):
|
||||
|
||||
- Martine S. Lenders <m.lenders@fu-berlin.de>
|
||||
|
||||
Reason for removal:
|
||||
|
||||
- Stale upstream (last update to date in Mar 2018)
|
||||
- Ported version even older (last update Feb 2016)
|
||||
- Updating to more recent version would be more effort than its worth
|
||||
|
||||
### pkg/libcoap [d83d08f0995a88f399e70a7d07b44dd780082436]
|
||||
|
||||
Author:
|
||||
|
||||
- Martine Lenders <mlenders@inf.fu-berlin.de>
|
||||
|
||||
Reasons for removal:
|
||||
|
||||
- Not maintained anymore, no updates for 8 years
|
||||
- Upstream libcoap allows building with RIOT, so there is a migration path for users
|
||||
|
||||
### pkg/nordic_softdevice_ble [35b6ccedf31f10a5f8e4f97609ad5b10c28bdc34]
|
||||
|
||||
Author(s):
|
||||
|
||||
- Hauke Petersen <hauke.petersen@fu-berlin.de>
|
||||
- Kaspar Schleiser <kaspar@schleiser.de>
|
||||
- Martine Lenders <m.lenders@fu-berlin.de>
|
||||
- Wojciech Bober <wojciech.bober@nordicsemi.no>
|
||||
|
||||
Reason for removal:
|
||||
|
||||
- Outdated, unmaintained and no longer working
|
||||
|
||||
### pkg/oonf_api [c829f820ee870bffc60c7df688d2da8373553212]
|
||||
|
||||
Author:
|
||||
|
||||
- Benjamin Valentin <benpicco@googlemail.com>
|
||||
|
||||
Reasons for removal:
|
||||
|
||||
- Package has not been update since 2013.
|
||||
- Tests were never integrated to the CI.
|
||||
- NHDP, which was the only upstream user, has been removed.
|
||||
|
||||
### pkg/qdsa [cc357f9638ce22a39eab8f79055f1154388ccb74]
|
||||
|
||||
Author(s):
|
||||
|
||||
- Kaspar Schleiser <kaspar@schleiser.de> (integration into RIOT as package)
|
||||
- Joost Renes <joost.renes@nxp.com> (upstream code)
|
||||
|
||||
Reason for removal:
|
||||
|
||||
- No users besides the test
|
||||
- The qDSA signature does not seem to have received the level of attention and
|
||||
scrutiny by the crypto community that would justify inclusion in a general
|
||||
purpose OS
|
||||
|
||||
### sys/irq_handler [a2dd6f90e51ca9edef643ba72bd1fd18113cf0d2]
|
||||
|
||||
Author(s):
|
||||
|
||||
- Gunar Schorcht <gunar@schorcht.net>
|
||||
|
||||
Reason for removal:
|
||||
|
||||
- Provides some feature as `sys/event_thread`
|
||||
- Has been deprecated directly in the first release it was provided
|
||||
|
||||
### sys/net/gnrc/application_layer/tftp [0e2a62078850e1ecc74db2db4d639cf2d8fb96d3]
|
||||
|
||||
Author:
|
||||
|
||||
- DipSwitch <dipswitch@ownage4u.nl>
|
||||
|
||||
Reasons for removal:
|
||||
|
||||
- Not maintained anymore.
|
||||
- Existing quality and security defects.
|
||||
|
||||
### sys/net/gnrc/nettest [cdc252ab7bd4161cc046bf93a3e55995704b24d4]
|
||||
|
||||
Author:
|
||||
|
||||
- Martine Lenders <mlenders@inf.fu-berlin.de>
|
||||
|
||||
Reasons for removal:
|
||||
|
||||
- Not maintained anymore
|
||||
- Not used in GNRC
|
||||
|
||||
### sys/net/routing/nhdp [9026823bb906f64168d7d38e52be92f390353dc8]
|
||||
|
||||
Author:
|
||||
|
||||
- Fabian Nack <nack@inf.fu-berlin.de>
|
||||
|
||||
Reasons for removal:
|
||||
|
||||
- Not maintained anymore.
|
||||
- Does not comply with the current RIOT programming practices.
|
||||
|
||||
### sys/ubjson [bea30c3f8949ebd9fdf4a9bf0a987652889930f5]
|
||||
|
||||
Author(s):
|
||||
|
||||
- René Kijewski <rene.kijewski@fu-berlin.de>
|
||||
|
||||
Reasons for removal:
|
||||
|
||||
- Unsafe code.
|
||||
- Did not comply with RIOT standards.
|
||||
- More standard alternatives available (such as CBOR).
|
||||
|
||||
[6cad5d24771ba6199228351a11b5062cd2e9b36d]: https://github.com/RIOT-OS/RIOT/commit/6cad5d24771ba6199228351a11b5062cd2e9b36d
|
||||
[d83d08f0995a88f399e70a7d07b44dd780082436]: https://github.com/RIOT-OS/RIOT/commit/d83d08f0995a88f399e70a7d07b44dd780082436
|
||||
@ -348,7 +431,6 @@ Reason for removal:
|
||||
[f2760c033c5f332be076b25aa212aca4007c3d65]: https://github.com/RIOT-OS/RIOT/commit/f2760c033c5f332be076b25aa212aca4007c3d65
|
||||
[e63cd54f3b1e002a7895bb7c46af889b341c1a15]: https://github.com/RIOT-OS/RIOT/commit/e63cd54f3b1e002a7895bb7c46af889b341c1a15
|
||||
[4f243c52eabefe709d78560ce7f1d502d737a999]: https://github.com/RIOT-OS/RIOT/commit/4f243c52eabefe709d78560ce7f1d502d737a999
|
||||
[3cac6e0979468ba56659291fd1cd11096611589d]: https://github.com/RIOT-OS/RIOT/commit/3cac6e0979468ba56659291fd1cd11096611589d
|
||||
[9fb2f541baca469e34fa01b004d6f19385700ce9]: https://github.com/RIOT-OS/RIOT/commit/9fb2f541baca469e34fa01b004d6f19385700ce9
|
||||
[35b6ccedf31f10a5f8e4f97609ad5b10c28bdc34]: https://github.com/RIOT-OS/RIOT/commit/35b6ccedf31f10a5f8e4f97609ad5b10c28bdc34
|
||||
[72821a502f073006643cb4ef7815fc8c42563ce6]: https://github.com/RIOT-OS/RIOT/commit/72821a502f073006643cb4ef7815fc8c42563ce6
|
||||
|
||||
@ -182,7 +182,7 @@ announcement can be skipped and the fix merged once at least two ACKs are
|
||||
there.
|
||||
|
||||
[list of maintainers]: https://riot-os.org/maintainers.html
|
||||
[Best Practices]: https://doc.riot-os.org/dev-best-practices.html
|
||||
[Comparing build sizes]: https://doc.riot-os.org/advanced-build-system-tricks.html#comparing-build-sizes
|
||||
[Coding Conventions]: CODING_CONVENTIONS.md
|
||||
[Code of Conduct]: https://github.com/RIOT-OS/RIOT/blob/master/CODE_OF_CONDUCT.md
|
||||
[Best Practices]: https://guide.riot-os.org/misc/dev_best_practices/
|
||||
[Comparing build sizes]: https://guide.riot-os.org/build-system/advanced_build_system_tricks/#comparing-build-sizes
|
||||
[Coding Conventions]: https://guide.riot-os.org/c_tutorials/coding_conventions/
|
||||
[Code of Conduct]: https://guide.riot-os.org/general/code_of_conduct/
|
||||
|
||||
2
Makefile
2
Makefile
@ -62,7 +62,7 @@ define welcome_message
|
||||
@echo "Usually, you should run 'make' in your application's directory instead."
|
||||
@echo ""
|
||||
@echo "Please see our Quick Start Guide at:"
|
||||
@echo " https://doc.riot-os.org/getting-started.html"
|
||||
@echo " https://guide.riot-os.org/getting-started/installing/"
|
||||
@echo "You can ask questions or discuss with other users on our forum:"
|
||||
@echo " https://forum.riot-os.org"
|
||||
@echo ""
|
||||
|
||||
@ -494,7 +494,7 @@ The easiest way to use the ESP32 toolchain is to use the RIOT Docker build
|
||||
image. It is specially prepared for building RIOT applications for various
|
||||
platforms and already has all the required tools and packages installed.
|
||||
Details on how to setup Docker can be found in section
|
||||
[Getting Started](https://doc.riot-os.org/getting-started.html#docker).
|
||||
[Build in Docker](https://guide.riot-os.org/build-system/build-in-docker/).
|
||||
|
||||
The building process using Docker comprises two steps:
|
||||
|
||||
@ -522,7 +522,7 @@ $ BUILD_IN_DOCKER=1 make flash BOARD=...
|
||||
### Prerequisites
|
||||
|
||||
In addition to the common tools defined in section
|
||||
[Getting Started - Common Tools](https://doc.riot-os.org/getting-started.html#compiling-riot),
|
||||
[Getting Started - Setup Development Environment](https://guide.riot-os.org/getting-started/installing/),
|
||||
the following tools or packages are required to install and use the ESP32
|
||||
toolchain (Debian/Ubuntu package names):
|
||||
|
||||
|
||||
2
dist/tools/usb-serial/README.md
vendored
2
dist/tools/usb-serial/README.md
vendored
@ -77,7 +77,7 @@ By adding
|
||||
|
||||
to the `Makefile.include` of your board, running `make MOST_RECENT_PORT=1 term`
|
||||
will connect to the most recently connected board matching the provided
|
||||
filters. Refer to https://api.riot-os.org/flashing.html#multiple-boards-simple
|
||||
filters. Refer to https://guide.riot-os.org/build-system/flashing/#handling-multiple-boards-simplest-approach
|
||||
for more details.
|
||||
|
||||
`list-ttys.sh`
|
||||
|
||||
@ -450,7 +450,7 @@ reserved for the cases described below:
|
||||
| `CPU_CORE_` | Models a CPU core |
|
||||
| `CPU_FAM_` | Models a family of CPUs |
|
||||
| `CPU_MODEL_` | Models a particular model of CPU |
|
||||
| `USEMODULE_` | Models a [RIOT module](https://doc.riot-os.org/creating-modules.html#creating-modules). Generated from `USEMODULE` variable |
|
||||
| `USEMODULE_` | Models a [RIOT module](https://guide.riot-os.org/advanced_tutorials/creating_modules/). Generated from `USEMODULE` variable |
|
||||
| `USEPKG_` | Models an [external package](https://doc.riot-os.org/group__pkg.html). Generated from `USEPKG` variable |
|
||||
|
||||
---
|
||||
|
||||
@ -57,7 +57,7 @@ Sadly, not everyone knows this.
|
||||
|
||||
However, even if everyone was kind, everyone was compassionate, and everyone was
|
||||
familiar with codes of conduct it would still be incumbent upon our community to
|
||||
publish our own. Maintaining a code of conduct forces us to consider and
|
||||
publish our own. Maintaining a Code of Conduct forces us to consider and
|
||||
articulate what kind of community we want to be, and serves as a constant
|
||||
reminder to put our best foot forward. But most importantly, it serves as a
|
||||
signpost to people looking to join our community that we feel these values are
|
||||
|
||||
@ -3,7 +3,7 @@ title: Reporting Guidelines
|
||||
description: How to report violations of the RIOT Code of Conduct
|
||||
---
|
||||
|
||||
If you believe someone is violating the [code of conduct](/general/code_of_conduct/)
|
||||
If you believe someone is violating the [Code of Conduct](/general/code_of_conduct/)
|
||||
we ask that you report it to us by emailing <conduct@riot-os.org>.
|
||||
Currently, the recipients of
|
||||
this email address are [\@OlegHahm](https://github.com/OlegHahm) (Oleg Hahm) and
|
||||
@ -48,7 +48,7 @@ much quicker than that).
|
||||
They will review the incident and determine:
|
||||
|
||||
- What happened.
|
||||
- Whether this event constitutes a code of conduct violation.
|
||||
- Whether this event constitutes a Code of Conduct violation.
|
||||
- Who the bad actor was.
|
||||
- Whether this is an ongoing situation, or if there is a threat to anyone's
|
||||
physical safety.
|
||||
|
||||
@ -75,7 +75,7 @@ scheme. Examples for this is code shared across architectures (e.g.
|
||||
`cortexm_common`, `msp430_comon`) or code shared among vendors (e.g.
|
||||
`stm32_common`).
|
||||
|
||||
See [CPU](https://doc.riot-os.org/build-system-basics.html#cpu) for more detailed information.
|
||||
See [CPU](https://guide.riot-os.org/build-system/build_system_basics/#cpucpu_model) for more detailed information.
|
||||
|
||||
drivers
|
||||
-------
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
title: Code of Conduct
|
||||
description: This document outlines the code of conduct for contributors of RIOT.
|
||||
description: This document outlines the Code of Conduct for contributors of RIOT.
|
||||
slug: general/code_of_conduct
|
||||
---
|
||||
|
||||
@ -41,7 +41,7 @@ i.e., including the modules that are part of RIOT itself.
|
||||
|
||||
If not manually specified via `SRC`, all source files which reside
|
||||
directly in the module's directory are considered part of the module.
|
||||
RIOT modules are also described in greater detail [in the documentation](https://doc.riot-os.org/creating-modules.html).
|
||||
RIOT modules are also described in greater detail [in the documentation](https://guide.riot-os.org/advanced_tutorials/creating_modules/).
|
||||
|
||||
Two lines need to be added to the application's Makefile in order to compile and use the module:
|
||||
|
||||
@ -52,7 +52,7 @@ USEMODULE += module
|
||||
|
||||
The path added to `EXTERNAL_MODULE_DIRS` is the parent directory of the external module,
|
||||
while the string added to `USEMODULE` has to match the module's directory name.
|
||||
External modules are described in greater detail [in the documentation](https://doc.riot-os.org/creating-an-application.html#autotoc_md2308).
|
||||
External modules are described in greater detail [in the documentation](https://guide.riot-os.org/advanced_tutorials/creating_application/#external-modules).
|
||||
|
||||
|
||||
### Subfolders
|
||||
|
||||
@ -41,10 +41,10 @@ $(CARGO_COMPILE_COMMANDS): $(BUILDDEPS)
|
||||
|
||||
cargo-preflight: FORCE
|
||||
@command -v cargo >/dev/null || ($(COLOR_ECHO) \
|
||||
'$(COLOR_RED)Error: `cargo` command missing to build Rust modules.$(COLOR_RESET) Please install as described on <https://doc.riot-os.org/using-rust.html>.' ;\
|
||||
'$(COLOR_RED)Error: `cargo` command missing to build Rust modules.$(COLOR_RESET) Please install as described on <https://guide.riot-os.org/rust_tutorials/rust_in_riot/>.' ;\
|
||||
exit 1)
|
||||
@command -v $${C2RUST:-c2rust} >/dev/null || ($(COLOR_ECHO) \
|
||||
'$(COLOR_RED)Error: `'$${C2RUST:-c2rust}'` command missing to build Rust modules.$(COLOR_RESET) Please install as described on <https://doc.riot-os.org/using-rust.html>.' ;\
|
||||
'$(COLOR_RED)Error: `'$${C2RUST:-c2rust}'` command missing to build Rust modules.$(COLOR_RESET) Please install as described on <https://guide.riot-os.org/rust_tutorials/rust_in_riot/>.' ;\
|
||||
exit 1)
|
||||
@command -v rustup >/dev/null || ($(COLOR_ECHO) \
|
||||
'$(COLOR_RED)Error: `rustup` command missing.$(COLOR_RESET) While it is not essential for building Rust modules, it is the only known way to install the target core libraries (or nightly for -Zbuild-std) needed to do so. If you do think that building should be possible, please edit this file, and file an issue about building Rust modules with the installation method you are using -- later checks in this file, based on rustup, will need to be adjusted for that.' ;\
|
||||
|
||||
@ -43,7 +43,7 @@ include $(RIOTBASE)/Makefile.include
|
||||
|
||||
# export IFACE variable to environment of dhcpv6_server and
|
||||
# test-with-config/check-config rules
|
||||
# see: https://doc.riot-os.org/build-system-basics.html#variable-declaration-guidelines
|
||||
# see: https://guide.riot-os.org/build-system/build_system_basics/#variables-declaration-guidelines
|
||||
$(call target-export-variables,dhcpv6_server test-with-config/check-config,IFACE)
|
||||
|
||||
dhcpv6_server:
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user