_/qmk_firmware
1
0
Fork 0
Code Releases Activity

Update C coding conventions to match .clang-format config for i… (#8717)

Browse source 
* Update C coding conventions to match current .clang-format config for indenting PP directives

* Make indenting guideline clearer
This commit is contained in:
Konstantin Đorđević 2020-04-07 06:14:08 +02:00 committed by GitHub
parent 0a643be39e
commit f4b67cde8a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docs/coding_conventions_c.md
View file

@ -20,11 +20,11 @@ Most of our style is pretty easy to pick up on, but right now it's not entirely
* We accept both forms of preprocessor if's: `#ifdef DEFINED` and `#if defined(DEFINED)` * We accept both forms of preprocessor if's: `#ifdef DEFINED` and `#if defined(DEFINED)`
* If you are not sure which to prefer use the `#if defined(DEFINED)` form. * If you are not sure which to prefer use the `#if defined(DEFINED)` form.
* Do not change existing code from one style to the other, except when moving to a multiple condition `#if`. * Do not change existing code from one style to the other, except when moving to a multiple condition `#if`.
* Do not put whitespace between `#` and `if`. * When deciding how (or if) to indent preprocessor directives, keep these points in mind:
* When deciding how (or if) to indent directives keep these points in mind: * Readability is more important than consistency.
* Readability is more important than consistency. * Follow the file's existing style. If the file is mixed, follow the style that makes sense for the section you are modifying.
* Follow the file's existing style. If the file is mixed follow the style that makes sense for the section you are modifying. * When indenting, keep the hash at the start of the line and add whitespace between `#` and `if`, starting with 4 spaces after the `#`.
* When choosing to indent you can follow the indention level of the surrounding C code, or preprocessor directives can have their own indent level. Choose the style that best communicates the intent of your code. * You can follow the indention level of the surrounding C code, or preprocessor directives can have their own indentation levels. Choose the style that best communicates the intent of your code.
Here is an example for easy reference: Here is an example for easy reference: