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

CODING_CONVENTIONS: Add reference to IS_ACTIVE and IS_USED macros.

Browse Source
This commit is contained in:
Leandro Lanzieri 2019-11-11 16:34:14 +01:00
parent a78bdaa85a
commit 2c5626b6c0
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
CODING_CONVENTIONS.md
View File

@ -26,6 +26,11 @@
[completely different](https://www.kernel.org/doc/html/latest/process/coding-style.html#typedefs)
(see below) (BTW: Do we have any reason to do so?)
* Comments should be C-style comments (see below)
* In order to follow Linux's recommendation on
[conditional compilation](https://www.kernel.org/doc/html/latest/process/coding-style.html#conditional-compilation)
make use of `IS_ACTIVE` and `IS_USED` macros from `kernel_defines.h` with C
conditionals. If a symbol is not going to be defined under a certain
condition, the usage of preprocessor `#if defined()` is fine.
* You can use [uncrustify](http://uncrustify.sourceforge.net/) with the provided
option files: https://github.com/RIOT-OS/RIOT/blob/master/uncrustify-riot.cfg