diff options
author | Evan Lloyd <evan.lloyd@arm.com> | 2017-12-06 19:05:40 +0000 |
---|---|---|
committer | Evan Lloyd <evan.lloyd@arm.com> | 2018-05-01 18:40:18 +0100 |
commit | 5d9cef94fbeff4bd9ac9f9ca62038ec25a7e2cb6 (patch) | |
tree | 29119bb8466adffa0358a1043d560c4c5f10f3c7 /.editorconfig | |
parent | a8d9550b527107b85703d7b4e93073e653ae95f7 (diff) |
Add .editorconfig file
The .editorconfig file provides an editor agnostic definition of a
project's file format requirements.
Details can be found at http://editorconfig.org/
This change should have little impact on users, but, it is hoped, will
help those who move across projects avoid making mistakes because of
foreign project editor configuration settings.
Change-Id: I8776526b5ab96b543d3d3e445c60e06b62049e68
Signed-off-by: Evan Lloyd <evan.lloyd@arm.com>
Diffstat (limited to '.editorconfig')
-rw-r--r-- | .editorconfig | 62 |
1 files changed, 62 insertions, 0 deletions
diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 00000000..0e7a5c3c --- /dev/null +++ b/.editorconfig @@ -0,0 +1,62 @@ +# +# Copyright (c) 2017, ARM Limited and Contributors. All rights reserved. +# +# SPDX-License-Identifier: BSD-3-Clause +# + +# ARM Trusted Firmware Coding style spec for editors. + +# References: +# [EC] http://editorconfig.org/ +# [CONT] contributing.rst +# [LCS] Linux Coding Style +# (https://www.kernel.org/doc/html/v4.10/process/coding-style.html) + + +root = true + +# set default to match [LCS] .c/.h settings. +# This will also apply to .S, .mk, .sh, Makefile, .dts, etc. +[*] +# Not specified, but fits current ARM-TF sources. +charset = utf-8 + +# Not specified, but implicit for "LINUX coding style". +end_of_line = lf + +# [LCS] Chapter 1: Indentation +# "and thus indentations are also 8 characters" +indent_size = 8 + +# [LCS] Chapter 1: Indentation +# "Outside of comments,...spaces are never used for indentation" +indent_style = tab + +# Not specified by [LCS], but sensible +insert_final_newline = true + +# [LCS] Chapter 2: Breaking long lines and strings +# "The limit on the length of lines is 80 columns" +# This is a "soft" requirement for Arm-TF, and should not be the sole +# reason for changes. +max_line_length = 80 + +# [LCS] Chapter 1: Indentation +# "Tabs are 8 characters" +tab_width = 8 + +# [LCS] Chapter 1: Indentation +# "Get a decent editor and don't leave whitespace at the end of lines." +# [LCS] Chapter 3.1: Spaces +# "Do not leave trailing whitespace at the ends of lines." +trim_trailing_whitespace = true + + +# Adjustment for existing .rst files with different format +[*.{rst,md}] +indent_size = 4 +indent_style = space +max_line_length = 180 +# 180 only selected to prevent changes to existing text. +tab_width = 4 + |