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

93 lines
1.2 KiB
INI
Raw Normal View History

editorconfig: basic EditorConfig configuration EditorConfig (https://editorconfig.org) is a widely supported configuration tool that helps to ensure better consistency amongst developers by auto-configuring an editor to match the original/intended style i.e. tab-width etc. This configuration covers many of the common file formats used in zephyr. The configuration was derived by looking at existing files and ascertaining what configuration they currently use. This is the top-most EditorConfig file meaning this is the root of all other EditorConfigs, however sub-directories can set their own up if they wish to override this. This has proven especially useful when viewing uncrustified C source code where the tab-width should be 8 to get proper alignment but many editors use a tab-width of 4. Lots of editors support this natively and those that do not probably have a plugin or extension. Tested by opening and saving various files to ensure no changes occurred. Signed-off-by: Carlos Stuart <carlosstuart1970@gmail.com>
2019-02-02 20:07:49 +08:00
# EditorConfig: https://editorconfig.org/
# top-most EditorConfig file
root = true
# All (Defaults)
[*]
charset = utf-8
end_of_line = lf
editorconfig: Set insert_final_newline true This is what checkpatch.pl expects, and GitHub's file viewer flags a missing trailing newline too. Note that this is different from a blank line at the end of the file. It just says whether the last line must end in a newline. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-04-09 23:45:05 +08:00
insert_final_newline = true
editorconfig: basic EditorConfig configuration EditorConfig (https://editorconfig.org) is a widely supported configuration tool that helps to ensure better consistency amongst developers by auto-configuring an editor to match the original/intended style i.e. tab-width etc. This configuration covers many of the common file formats used in zephyr. The configuration was derived by looking at existing files and ascertaining what configuration they currently use. This is the top-most EditorConfig file meaning this is the root of all other EditorConfigs, however sub-directories can set their own up if they wish to override this. This has proven especially useful when viewing uncrustified C source code where the tab-width should be 8 to get proper alignment but many editors use a tab-width of 4. Lots of editors support this natively and those that do not probably have a plugin or extension. Tested by opening and saving various files to ensure no changes occurred. Signed-off-by: Carlos Stuart <carlosstuart1970@gmail.com>
2019-02-02 20:07:49 +08:00
trim_trailing_whitespace = true
editorconfig: Update maximum line length to 100 This commit updates the maximum line length from 80 to 100 as per the GitHub issue #30426 ("Enforce all checkpatch warnings and move to 100 characters per line"). Signed-off-by: Stephanos Ioannidis <root@stephanos.io>
2022-04-28 01:48:32 +08:00
max_line_length = 100
editorconfig: basic EditorConfig configuration EditorConfig (https://editorconfig.org) is a widely supported configuration tool that helps to ensure better consistency amongst developers by auto-configuring an editor to match the original/intended style i.e. tab-width etc. This configuration covers many of the common file formats used in zephyr. The configuration was derived by looking at existing files and ascertaining what configuration they currently use. This is the top-most EditorConfig file meaning this is the root of all other EditorConfigs, however sub-directories can set their own up if they wish to override this. This has proven especially useful when viewing uncrustified C source code where the tab-width should be 8 to get proper alignment but many editors use a tab-width of 4. Lots of editors support this natively and those that do not probably have a plugin or extension. Tested by opening and saving various files to ensure no changes occurred. Signed-off-by: Carlos Stuart <carlosstuart1970@gmail.com>
2019-02-02 20:07:49 +08:00
editorconfig: Add assembly code file spec This commit adds the editorconfig spec for assembly code files (*.S). Signed-off-by: Stephanos Ioannidis <root@stephanos.io>
2020-03-18 08:47:07 +08:00
# Assembly
[*.S]
indent_style = tab
indent_size = 8
editorconfig: basic EditorConfig configuration EditorConfig (https://editorconfig.org) is a widely supported configuration tool that helps to ensure better consistency amongst developers by auto-configuring an editor to match the original/intended style i.e. tab-width etc. This configuration covers many of the common file formats used in zephyr. The configuration was derived by looking at existing files and ascertaining what configuration they currently use. This is the top-most EditorConfig file meaning this is the root of all other EditorConfigs, however sub-directories can set their own up if they wish to override this. This has proven especially useful when viewing uncrustified C source code where the tab-width should be 8 to get proper alignment but many editors use a tab-width of 4. Lots of editors support this natively and those that do not probably have a plugin or extension. Tested by opening and saving various files to ensure no changes occurred. Signed-off-by: Carlos Stuart <carlosstuart1970@gmail.com>
2019-02-02 20:07:49 +08:00
# C
[*.{c,h}]
indent_style = tab
indent_size = 8
editorconfig: Add C++ indentation style This commit adds the indentation style for the C++ source and header files. Note that the C++ indentation style has been configured to match that of the C files because the C++ source files we currently have in the Zephyr repository follow the style we enforce for the C files. In the future, it may be preferable to follow the indentation style recommended by one of the common C++ style guides, such as the Google C++ Style Guide which recommends 2 spaces for indentation. Signed-off-by: Stephanos Ioannidis <root@stephanos.io>
2022-04-28 15:51:49 +08:00
# C++
[*.{cpp,hpp}]
indent_style = tab
indent_size = 8
editorconfig: Add linker script indentation style This commit adds the indentation style for the linker script files. Signed-off-by: Stephanos Ioannidis <root@stephanos.io>
2022-04-28 14:12:59 +08:00
# Linker Script
[*.ld]
indent_style = tab
indent_size = 8
editorconfig: basic EditorConfig configuration EditorConfig (https://editorconfig.org) is a widely supported configuration tool that helps to ensure better consistency amongst developers by auto-configuring an editor to match the original/intended style i.e. tab-width etc. This configuration covers many of the common file formats used in zephyr. The configuration was derived by looking at existing files and ascertaining what configuration they currently use. This is the top-most EditorConfig file meaning this is the root of all other EditorConfigs, however sub-directories can set their own up if they wish to override this. This has proven especially useful when viewing uncrustified C source code where the tab-width should be 8 to get proper alignment but many editors use a tab-width of 4. Lots of editors support this natively and those that do not probably have a plugin or extension. Tested by opening and saving various files to ensure no changes occurred. Signed-off-by: Carlos Stuart <carlosstuart1970@gmail.com>
2019-02-02 20:07:49 +08:00
# Python
[*.py]
indent_style = space
indent_size = 4
# Perl
[*.pl]
indent_style = tab
indent_size = 8
editorconfig: Add reStructuredText indentation style This commit adds the reStructuredText indentation style. Signed-off-by: Stephanos Ioannidis <root@stephanos.io>
2022-04-28 01:56:09 +08:00
# reStructuredText
[*.rst]
indent_style = space
indent_size = 3
editorconfig: basic EditorConfig configuration EditorConfig (https://editorconfig.org) is a widely supported configuration tool that helps to ensure better consistency amongst developers by auto-configuring an editor to match the original/intended style i.e. tab-width etc. This configuration covers many of the common file formats used in zephyr. The configuration was derived by looking at existing files and ascertaining what configuration they currently use. This is the top-most EditorConfig file meaning this is the root of all other EditorConfigs, however sub-directories can set their own up if they wish to override this. This has proven especially useful when viewing uncrustified C source code where the tab-width should be 8 to get proper alignment but many editors use a tab-width of 4. Lots of editors support this natively and those that do not probably have a plugin or extension. Tested by opening and saving various files to ensure no changes occurred. Signed-off-by: Carlos Stuart <carlosstuart1970@gmail.com>
2019-02-02 20:07:49 +08:00
# YAML
editorconfig: add yaml file extension variant This commit adds *.yaml files to the yaml editorconfig section. Signed-off-by: Mikkel Jakobsen <mikkel.aunsbjerg@prevas.dk>
2020-03-25 21:31:23 +08:00
[*.{yml,yaml}]
editorconfig: basic EditorConfig configuration EditorConfig (https://editorconfig.org) is a widely supported configuration tool that helps to ensure better consistency amongst developers by auto-configuring an editor to match the original/intended style i.e. tab-width etc. This configuration covers many of the common file formats used in zephyr. The configuration was derived by looking at existing files and ascertaining what configuration they currently use. This is the top-most EditorConfig file meaning this is the root of all other EditorConfigs, however sub-directories can set their own up if they wish to override this. This has proven especially useful when viewing uncrustified C source code where the tab-width should be 8 to get proper alignment but many editors use a tab-width of 4. Lots of editors support this natively and those that do not probably have a plugin or extension. Tested by opening and saving various files to ensure no changes occurred. Signed-off-by: Carlos Stuart <carlosstuart1970@gmail.com>
2019-02-02 20:07:49 +08:00
indent_style = space
indent_size = 2
# Shell Script
[*.sh]
indent_style = space
indent_size = 4
# Windows Command Script
[*.cmd]
end_of_line = crlf
indent_style = tab
indent_size = 8
# Valgrind Suppression File
[*.supp]
indent_style = space
indent_size = 3
# CMake
[{CMakeLists.txt,*.cmake}]
indent_style = space
indent_size = 2
# Makefile
[Makefile]
editorconfig: Set insert_final_newline true This is what checkpatch.pl expects, and GitHub's file viewer flags a missing trailing newline too. Note that this is different from a blank line at the end of the file. It just says whether the last line must end in a newline. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-04-09 23:45:05 +08:00
indent_style = tab
editorconfig: Improve verbosity This commit adds missing `indent_size` configurations for some file types. Signed-off-by: Stephanos Ioannidis <root@stephanos.io>
2022-04-28 15:59:11 +08:00
indent_size = 8
editorconfig: add rules for device tree files Rules follow linux coding standard, i.e using tab and tab size 8 Signed-off-by: Mikkel Jakobsen <mikkel.aunsbjerg@prevas.dk>
2020-04-27 15:04:16 +08:00
# Device tree
[*.{dts,dtsi,overlay}]
indent_style = tab
indent_size = 8
editorconfig: use 72 characters line width git commit messages Configure editors for wrapping lines at 72 characters line width for Git commit messages. Signed-off-by: Henrik Brix Andersen <henrik@brixandersen.dk>
2020-06-21 05:44:27 +08:00
# Git commit messages
[COMMIT_EDITMSG]
editorconfig: Update commit message max. line length to 75 This commit updates the maximum line length for the commit messages from 72 to 75, in order to align with the checkpatch and gitlint policies. Signed-off-by: Stephanos Ioannidis <root@stephanos.io>
2022-04-28 01:52:10 +08:00
max_line_length = 75
editorconfig: indent Kconfig files with tabs Configure editors for indenting Kconfig* files with tabs. Signed-off-by: Henrik Brix Andersen <hebad@vestas.com>
2020-07-09 02:29:58 +08:00
# Kconfig
[Kconfig*]
editorconfig: Improve verbosity This commit adds missing `indent_size` configurations for some file types. Signed-off-by: Stephanos Ioannidis <root@stephanos.io>
2022-04-28 15:59:11 +08:00
indent_style = tab
indent_size = 8