OrgZephyr/zephyr
OrgZephyr
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr.git
1
0
Fork 0
Code Issues Releases Wiki Activity
zephyr/.clang-format

86 lines
2.5 KiB
Plaintext
Raw Normal View History

clang-format: simplify by inheriting from LLVM The amount of options available on clang-format has become quite extensive over-time, making a dumped file difficult to read or maintain. In this patch the .clang-format has been re-written by inheriting from LLVM (default) since most of the options can be re-used to match the Zephyr/Linux coding style conventions. Note: The 14 release has interesting options for Zephyr, in particular, these new settings would be beneficial: IfMacros: - CHECKIF SpaceBeforeParens: Custom SpaceBeforeParensOptions: AfterForeachMacros: true AfterIfMacros: true .clang-format should be periodically updated as new clang-format releases reach Linux distros. Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2021-12-17 23:16:48 +08:00
# SPDX-License-Identifier: Apache-2.0
clang-format: add support for clang-format Add .clang-format style from linux kernel to allow easier style formatting for developers that do not use uncrustify. You can call "clang-format -style=file -i my_src.c" within the repo to in-place fix the style. Signed-off-by: Håkon Alseth <haal@nordicsemi.no>
2018-10-04 20:21:59 +08:00
#
clang-format: simplify by inheriting from LLVM The amount of options available on clang-format has become quite extensive over-time, making a dumped file difficult to read or maintain. In this patch the .clang-format has been re-written by inheriting from LLVM (default) since most of the options can be re-used to match the Zephyr/Linux coding style conventions. Note: The 14 release has interesting options for Zephyr, in particular, these new settings would be beneficial: IfMacros: - CHECKIF SpaceBeforeParens: Custom SpaceBeforeParensOptions: AfterForeachMacros: true AfterIfMacros: true .clang-format should be periodically updated as new clang-format releases reach Linux distros. Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2021-12-17 23:16:48 +08:00
# Note: The list of ForEachMacros can be obtained using:
clang-format: add support for clang-format Add .clang-format style from linux kernel to allow easier style formatting for developers that do not use uncrustify. You can call "clang-format -style=file -i my_src.c" within the repo to in-place fix the style. Signed-off-by: Håkon Alseth <haal@nordicsemi.no>
2018-10-04 20:21:59 +08:00
#
clang-format: simplify by inheriting from LLVM The amount of options available on clang-format has become quite extensive over-time, making a dumped file difficult to read or maintain. In this patch the .clang-format has been re-written by inheriting from LLVM (default) since most of the options can be re-used to match the Zephyr/Linux coding style conventions. Note: The 14 release has interesting options for Zephyr, in particular, these new settings would be beneficial: IfMacros: - CHECKIF SpaceBeforeParens: Custom SpaceBeforeParensOptions: AfterForeachMacros: true AfterIfMacros: true .clang-format should be periodically updated as new clang-format releases reach Linux distros. Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2021-12-17 23:16:48 +08:00
# git grep -h '^#define [^[:space:]]*FOR_EACH[^[:space:]]*(' include/ \
# | sed "s,^#define \([^[:space:]]*FOR_EACH[^[:space:]]*\)(.*$, - '\1'," \
# | sort | uniq
clang-format: add support for clang-format Add .clang-format style from linux kernel to allow easier style formatting for developers that do not use uncrustify. You can call "clang-format -style=file -i my_src.c" within the repo to in-place fix the style. Signed-off-by: Håkon Alseth <haal@nordicsemi.no>
2018-10-04 20:21:59 +08:00
#
clang-format: simplify by inheriting from LLVM The amount of options available on clang-format has become quite extensive over-time, making a dumped file difficult to read or maintain. In this patch the .clang-format has been re-written by inheriting from LLVM (default) since most of the options can be re-used to match the Zephyr/Linux coding style conventions. Note: The 14 release has interesting options for Zephyr, in particular, these new settings would be beneficial: IfMacros: - CHECKIF SpaceBeforeParens: Custom SpaceBeforeParensOptions: AfterForeachMacros: true AfterIfMacros: true .clang-format should be periodically updated as new clang-format releases reach Linux distros. Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2021-12-17 23:16:48 +08:00
# References:
# - https://clang.llvm.org/docs/ClangFormatStyleOptions.html
clang-format: add support for clang-format Add .clang-format style from linux kernel to allow easier style formatting for developers that do not use uncrustify. You can call "clang-format -style=file -i my_src.c" within the repo to in-place fix the style. Signed-off-by: Håkon Alseth <haal@nordicsemi.no>
2018-10-04 20:21:59 +08:00
---
clang-format: simplify by inheriting from LLVM The amount of options available on clang-format has become quite extensive over-time, making a dumped file difficult to read or maintain. In this patch the .clang-format has been re-written by inheriting from LLVM (default) since most of the options can be re-used to match the Zephyr/Linux coding style conventions. Note: The 14 release has interesting options for Zephyr, in particular, these new settings would be beneficial: IfMacros: - CHECKIF SpaceBeforeParens: Custom SpaceBeforeParensOptions: AfterForeachMacros: true AfterIfMacros: true .clang-format should be periodically updated as new clang-format releases reach Linux distros. Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2021-12-17 23:16:48 +08:00
BasedOnStyle: LLVM
AlignConsecutiveMacros: AcrossComments
clang-format: do not merge blocks/functions into single line Align clang-format a bit closer to established coding style of the project. Similar to commit 51f9f7ca3019 ("clang-format: do not put enums in single line")' Never merge blocks/case/functions/if/loops into a single line. Signed-off-by: Johann Fischer <johann.fischer@nordicsemi.no>
2022-07-15 18:23:06 +08:00
AllowShortBlocksOnASingleLine: false
AllowShortCaseLabelsOnASingleLine: false
clang-format: do not put enums in single line clang-format puts short enums in one single line, making them unreadable. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-07-01 22:46:26 +08:00
AllowShortEnumsOnASingleLine: false
clang-format: do not merge blocks/functions into single line Align clang-format a bit closer to established coding style of the project. Similar to commit 51f9f7ca3019 ("clang-format: do not put enums in single line")' Never merge blocks/case/functions/if/loops into a single line. Signed-off-by: Johann Fischer <johann.fischer@nordicsemi.no>
2022-07-15 18:23:06 +08:00
AllowShortFunctionsOnASingleLine: None
AllowShortIfStatementsOnASingleLine: false
AllowShortLoopsOnASingleLine: false
clang-format: simplify by inheriting from LLVM The amount of options available on clang-format has become quite extensive over-time, making a dumped file difficult to read or maintain. In this patch the .clang-format has been re-written by inheriting from LLVM (default) since most of the options can be re-used to match the Zephyr/Linux coding style conventions. Note: The 14 release has interesting options for Zephyr, in particular, these new settings would be beneficial: IfMacros: - CHECKIF SpaceBeforeParens: Custom SpaceBeforeParensOptions: AfterForeachMacros: true AfterIfMacros: true .clang-format should be periodically updated as new clang-format releases reach Linux distros. Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2021-12-17 23:16:48 +08:00
AttributeMacros:
- __aligned
- __deprecated
- __packed
- __printf_like
- __syscall
- __subsystem
clang-format: remove space before colon To fit the bitfield check in scripts/checkpatch.pl from: uint8_t : 3; to: uint8_t: 3; Signed-off-by: Rafael Lee <rafaellee.img@gmail.com>
2022-11-16 02:56:54 +08:00
BitFieldColonSpacing: After
clang-format: simplify by inheriting from LLVM The amount of options available on clang-format has become quite extensive over-time, making a dumped file difficult to read or maintain. In this patch the .clang-format has been re-written by inheriting from LLVM (default) since most of the options can be re-used to match the Zephyr/Linux coding style conventions. Note: The 14 release has interesting options for Zephyr, in particular, these new settings would be beneficial: IfMacros: - CHECKIF SpaceBeforeParens: Custom SpaceBeforeParensOptions: AfterForeachMacros: true AfterIfMacros: true .clang-format should be periodically updated as new clang-format releases reach Linux distros. Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2021-12-17 23:16:48 +08:00
BreakBeforeBraces: Linux
clang-format: restore column limit value of 100 Restore line length limit of 100 characters as introduced in 6432a56ae9595f6b771930b5d1d3e8bc6820ec66. Fixes: bac0dbe8f26a4c9a1e4248c3d41c926d4378c91d Signed-off-by: Henrik Brix Andersen <hebad@vestas.com>
2022-06-28 04:02:21 +08:00
ColumnLimit: 100
clang-format: add support for clang-format Add .clang-format style from linux kernel to allow easier style formatting for developers that do not use uncrustify. You can call "clang-format -style=file -i my_src.c" within the repo to in-place fix the style. Signed-off-by: Håkon Alseth <haal@nordicsemi.no>
2018-10-04 20:21:59 +08:00
ConstructorInitializerIndentWidth: 8
ContinuationIndentWidth: 8
ForEachMacros:
- 'FOR_EACH'
clang-format: Update with latest FOR_EACH macro list Correct the shell fragment to use the spelling Zephyr uses, and re-run it to update the list. Signed-off-by: Peter Bigot <peter.bigot@nordicsemi.no>
2020-03-27 00:34:58 +08:00
- 'FOR_EACH_FIXED_ARG'
clang-format: update ForEachMacros Update the list of for each macros using the suggested command in the configuration file. Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2021-12-17 22:08:25 +08:00
- 'FOR_EACH_IDX'
- 'FOR_EACH_IDX_FIXED_ARG'
- 'FOR_EACH_NONEMPTY_TERM'
clang-format: add support for clang-format Add .clang-format style from linux kernel to allow easier style formatting for developers that do not use uncrustify. You can call "clang-format -style=file -i my_src.c" within the repo to in-place fix the style. Signed-off-by: Håkon Alseth <haal@nordicsemi.no>
2018-10-04 20:21:59 +08:00
- 'RB_FOR_EACH'
- 'RB_FOR_EACH_CONTAINER'
- 'SYS_DLIST_FOR_EACH_CONTAINER'
- 'SYS_DLIST_FOR_EACH_CONTAINER_SAFE'
- 'SYS_DLIST_FOR_EACH_NODE'
- 'SYS_DLIST_FOR_EACH_NODE_SAFE'
- 'SYS_SFLIST_FOR_EACH_CONTAINER'
- 'SYS_SFLIST_FOR_EACH_CONTAINER_SAFE'
- 'SYS_SFLIST_FOR_EACH_NODE'
- 'SYS_SFLIST_FOR_EACH_NODE_SAFE'
- 'SYS_SLIST_FOR_EACH_CONTAINER'
- 'SYS_SLIST_FOR_EACH_CONTAINER_SAFE'
- 'SYS_SLIST_FOR_EACH_NODE'
- 'SYS_SLIST_FOR_EACH_NODE_SAFE'
clang-format: update ForEachMacros Update the list of for each macros using the suggested command in the configuration file. Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2021-12-17 22:08:25 +08:00
- '_WAIT_Q_FOR_EACH'
- 'Z_FOR_EACH'
- 'Z_FOR_EACH_ENGINE'
- 'Z_FOR_EACH_EXEC'
- 'Z_FOR_EACH_FIXED_ARG'
- 'Z_FOR_EACH_FIXED_ARG_EXEC'
- 'Z_FOR_EACH_IDX'
- 'Z_FOR_EACH_IDX_EXEC'
- 'Z_FOR_EACH_IDX_FIXED_ARG'
- 'Z_FOR_EACH_IDX_FIXED_ARG_EXEC'
clang-format: add support for clang-format Add .clang-format style from linux kernel to allow easier style formatting for developers that do not use uncrustify. You can call "clang-format -style=file -i my_src.c" within the repo to in-place fix the style. Signed-off-by: Håkon Alseth <haal@nordicsemi.no>
2018-10-04 20:21:59 +08:00
- 'Z_GENLIST_FOR_EACH_CONTAINER'
- 'Z_GENLIST_FOR_EACH_CONTAINER_SAFE'
- 'Z_GENLIST_FOR_EACH_NODE'
- 'Z_GENLIST_FOR_EACH_NODE_SAFE'
clang-format: disable regrouping and sorting of includes Disable regrouping and sorting of includes which can cause issues due to order requirements in some subsystems. Fixes #48520 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-08-20 02:57:17 +08:00
# Disabled for now, see bug https://github.com/zephyrproject-rtos/zephyr/issues/48520
#IncludeBlocks: Regroup
clang-format: add support for clang-format Add .clang-format style from linux kernel to allow easier style formatting for developers that do not use uncrustify. You can call "clang-format -style=file -i my_src.c" within the repo to in-place fix the style. Signed-off-by: Håkon Alseth <haal@nordicsemi.no>
2018-10-04 20:21:59 +08:00
IncludeCategories:
clang-format: simplify by inheriting from LLVM The amount of options available on clang-format has become quite extensive over-time, making a dumped file difficult to read or maintain. In this patch the .clang-format has been re-written by inheriting from LLVM (default) since most of the options can be re-used to match the Zephyr/Linux coding style conventions. Note: The 14 release has interesting options for Zephyr, in particular, these new settings would be beneficial: IfMacros: - CHECKIF SpaceBeforeParens: Custom SpaceBeforeParensOptions: AfterForeachMacros: true AfterIfMacros: true .clang-format should be periodically updated as new clang-format releases reach Linux distros. Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2021-12-17 23:16:48 +08:00
- Regex: '^".*\.h"$'
Priority: 0
- Regex: '^<(assert|complex|ctype|errno|fenv|float|inttypes|limits|locale|math|setjmp|signal|stdarg|stdbool|stddef|stdint|stdio|stdlib|string|tgmath|time|wchar|wctype)\.h>$'
clang-format: add support for clang-format Add .clang-format style from linux kernel to allow easier style formatting for developers that do not use uncrustify. You can call "clang-format -style=file -i my_src.c" within the repo to in-place fix the style. Signed-off-by: Håkon Alseth <haal@nordicsemi.no>
2018-10-04 20:21:59 +08:00
Priority: 1
clang-format: simplify by inheriting from LLVM The amount of options available on clang-format has become quite extensive over-time, making a dumped file difficult to read or maintain. In this patch the .clang-format has been re-written by inheriting from LLVM (default) since most of the options can be re-used to match the Zephyr/Linux coding style conventions. Note: The 14 release has interesting options for Zephyr, in particular, these new settings would be beneficial: IfMacros: - CHECKIF SpaceBeforeParens: Custom SpaceBeforeParensOptions: AfterForeachMacros: true AfterIfMacros: true .clang-format should be periodically updated as new clang-format releases reach Linux distros. Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2021-12-17 23:16:48 +08:00
- Regex: '^\<zephyr/.*\.h\>$'
Priority: 2
- Regex: '.*'
Priority: 3
clang-format: add support for clang-format Add .clang-format style from linux kernel to allow easier style formatting for developers that do not use uncrustify. You can call "clang-format -style=file -i my_src.c" within the repo to in-place fix the style. Signed-off-by: Håkon Alseth <haal@nordicsemi.no>
2018-10-04 20:21:59 +08:00
IndentCaseLabels: false
IndentWidth: 8
clang-format: simplify by inheriting from LLVM The amount of options available on clang-format has become quite extensive over-time, making a dumped file difficult to read or maintain. In this patch the .clang-format has been re-written by inheriting from LLVM (default) since most of the options can be re-used to match the Zephyr/Linux coding style conventions. Note: The 14 release has interesting options for Zephyr, in particular, these new settings would be beneficial: IfMacros: - CHECKIF SpaceBeforeParens: Custom SpaceBeforeParensOptions: AfterForeachMacros: true AfterIfMacros: true .clang-format should be periodically updated as new clang-format releases reach Linux distros. Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2021-12-17 23:16:48 +08:00
# SpaceBeforeParens: ControlStatementsExceptControlMacros # clang-format >= 13.0
clang-format: disable regrouping and sorting of includes Disable regrouping and sorting of includes which can cause issues due to order requirements in some subsystems. Fixes #48520 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-08-20 02:57:17 +08:00
SortIncludes: false
clang-format: add support for clang-format Add .clang-format style from linux kernel to allow easier style formatting for developers that do not use uncrustify. You can call "clang-format -style=file -i my_src.c" within the repo to in-place fix the style. Signed-off-by: Håkon Alseth <haal@nordicsemi.no>
2018-10-04 20:21:59 +08:00
UseTab: Always
clang-format: simplify by inheriting from LLVM The amount of options available on clang-format has become quite extensive over-time, making a dumped file difficult to read or maintain. In this patch the .clang-format has been re-written by inheriting from LLVM (default) since most of the options can be re-used to match the Zephyr/Linux coding style conventions. Note: The 14 release has interesting options for Zephyr, in particular, these new settings would be beneficial: IfMacros: - CHECKIF SpaceBeforeParens: Custom SpaceBeforeParensOptions: AfterForeachMacros: true AfterIfMacros: true .clang-format should be periodically updated as new clang-format releases reach Linux distros. Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2021-12-17 23:16:48 +08:00
WhitespaceSensitiveMacros:
- STRINGIFY
- Z_STRINGIFY