1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 01:09:47 +01:00
Commit Graph

11 Commits

Author SHA1 Message Date
Marian Buschsieweke
afb16bb705
Merge pull request #20570 from maribu/doc/coding-convention/IWYU
CODING_CONVENTIONS.md: Add IWYU policy
2024-11-04 15:27:48 +00:00
Marian Buschsieweke
ffeb46fc42
CODING_CONVENTIONS.md: Add IWYU policy
This makes an implicit agreement that code should include the headers
is uses, no more and no less, explicit.

It also recommends using tooling (such as clangd) and adding IWUY
pragma comments to aid those tools in common cases they otherwise would
provide false positives.

Co-authored-by: chrysn <chrysn@fsfe.org>
2024-11-04 16:24:28 +01:00
Marian Buschsieweke
f431aab856
CODING_CONVENTIONS.md: Add preprocessor directive formatting
This explicitly spells out what informally has been the coding
convention for some time on preprocessor directives, making it
more transparent and easier to find.

This is particularly useful as the code base has at least three
different styles. Deducing what actually is the current policy
would require a details look at how the style has changed over
time, rather than being obvious from a quick `grep` over the
code base.
2024-09-23 17:08:05 +02:00
Frederik Haxel
b5a43801fb print: Added size_t print format specifier
- Added `PRIuSIZE`, `PRIxSIZE`, etc. to `architecure.h`
- Changed `CODING_CONVENTIONS.md` regarding `size_t` printing

Co-authored-by: Marian Buschsieweke <marian.buschsieweke@posteo.net>
2023-12-21 12:02:16 +01:00
Marian Buschsieweke
edc43201db
tree-wide: fix typos in doc and comments
This should not change any generated binary
2023-10-16 12:17:48 +02:00
Karl Fessel
a7e2177356
Coding_Convention: clarify: none return is allowed
returning void is allowed changed Any to Every and clarify the message
2021-03-08 14:46:34 +01:00
Benjamin Valentin
95f814b5da CODING_CONVENTIONS.md: default to C11
The standard is 9 years old now, it is well supported in all mayor compilers.
In fact, features of the 'new' standard are already used in RIOT (std_atomic).

Let's make it the default and adapt the Makefiles accordingly.
2021-02-14 14:28:13 +01:00
bf887b6147
CODING_CONVENTIONS.md: fix typo 'seperate' -> 'separate' 2020-10-02 07:47:17 +02:00
Benjamin Valentin
7c4097bd52 CODING_CONVENTIONS.md: add a note about float
Floating point math should be avoided in the embedded space.
2020-07-14 20:41:00 +02:00
Leandro Lanzieri
2c5626b6c0 CODING_CONVENTIONS: Add reference to IS_ACTIVE and IS_USED macros. 2019-11-22 14:42:56 +01:00
Marian Buschsieweke
bf117a4e9c
Added CODING_CONVENTIONS.md 2019-10-25 10:44:56 +02:00