blob: 12f786de5ab4c9b2579ffd803d843bf8f17195cb [file] [log] [blame]
Evan Lloyd5d9cef92017-12-06 19:05:40 +00001#
Yann Gautier279f77b2020-08-19 19:07:26 +02002# Copyright (c) 2017-2020, Arm Limited and Contributors. All rights reserved.
Evan Lloyd5d9cef92017-12-06 19:05:40 +00003#
4# SPDX-License-Identifier: BSD-3-Clause
5#
6
John Tsichritzisbd97f832019-07-05 14:22:12 +01007# Trusted Firmware-A Coding style spec for editors.
Evan Lloyd5d9cef92017-12-06 19:05:40 +00008
9# References:
10# [EC] http://editorconfig.org/
11# [CONT] contributing.rst
12# [LCS] Linux Coding Style
13# (https://www.kernel.org/doc/html/v4.10/process/coding-style.html)
Justin Chadwell40b06512019-08-27 09:43:47 +010014# [PEP8] Style Guide for Python Code
15# (https://www.python.org/dev/peps/pep-0008)
Evan Lloyd5d9cef92017-12-06 19:05:40 +000016
17
18root = true
19
20# set default to match [LCS] .c/.h settings.
21# This will also apply to .S, .mk, .sh, Makefile, .dts, etc.
22[*]
23# Not specified, but fits current ARM-TF sources.
24charset = utf-8
25
26# Not specified, but implicit for "LINUX coding style".
27end_of_line = lf
28
29# [LCS] Chapter 1: Indentation
30# "and thus indentations are also 8 characters"
31indent_size = 8
32
33# [LCS] Chapter 1: Indentation
34# "Outside of comments,...spaces are never used for indentation"
35indent_style = tab
36
37# Not specified by [LCS], but sensible
38insert_final_newline = true
39
40# [LCS] Chapter 2: Breaking long lines and strings
Yann Gautier279f77b2020-08-19 19:07:26 +020041# "The limit on the length of lines is 100 columns"
Evan Lloyd5d9cef92017-12-06 19:05:40 +000042# This is a "soft" requirement for Arm-TF, and should not be the sole
43# reason for changes.
Yann Gautier279f77b2020-08-19 19:07:26 +020044max_line_length = 100
Evan Lloyd5d9cef92017-12-06 19:05:40 +000045
46# [LCS] Chapter 1: Indentation
47# "Tabs are 8 characters"
48tab_width = 8
49
50# [LCS] Chapter 1: Indentation
51# "Get a decent editor and don't leave whitespace at the end of lines."
52# [LCS] Chapter 3.1: Spaces
53# "Do not leave trailing whitespace at the ends of lines."
54trim_trailing_whitespace = true
55
56
Paul Beesleybbf0a1e2019-10-21 16:37:13 +000057# Adjustment for ReStructuredText (RST) documentation
58[*.{rst}]
Evan Lloyd5d9cef92017-12-06 19:05:40 +000059indent_size = 4
60indent_style = space
Evan Lloyd5d9cef92017-12-06 19:05:40 +000061
Justin Chadwell40b06512019-08-27 09:43:47 +010062
63# Adjustment for python which prefers a different style
64[*.py]
65# [PEP8] Indentation
66# "Use 4 spaces per indentation level."
67indent_size = 4
68indent_style = space
69
70# [PEP8] Maximum Line Length
71# "Limit all lines to a maximum of 79 characters."
72max_line_length = 79