From 6f9beef335de5baff72e146a8af9754973d598e4 Mon Sep 17 00:00:00 2001 From: "brian m. carlson" Date: Mon, 8 Oct 2018 22:03:52 +0000 Subject: [PATCH 1/2] editorconfig: provide editor settings for Git developers Contributors to Git use a variety of editors, each with their own configuration files. Because C lacks the defined norms on how to indent and style code that other languages, such as Ruby and Rust, have, it's possible for various contributors, especially new ones, to have configured their editor to use a style other than the style the Git community prefers. To make automatically configuring one's editor easier, provide an EditorConfig file. This is an INI-style configuration file that can be used to specify editor settings and can be understood by a wide variety of editors. Some editors include this support natively; others require a plugin. Regardless, providing such a file allows users to automatically configure their editor of choice with the correct settings by default. Provide global settings to set the character set to UTF-8 and insert a final newline into files. Provide language-specific settings for C, Shell, Perl, and Python files according to what CodingGuidelines already specifies. Since the indentation of other files varies, especially certain AsciiDoc files, don't provide any settings for them until a clear consensus forward emerges. Set the line length for commit messages to 72 characters, which is the generally accepted line length for emails, since we send patches by email. Don't specify an end of line type. While the Git community uses Unix-style line endings in the repository, some Windows users may use Git's auto-conversion support and forcing Unix-style line endings might cause problems for those users. Finally, leave out a root directive, which would prevent reading other EditorConfig files higher up in the tree, in case someone wants to set the end of line type for their system in such a file. Signed-off-by: brian m. carlson Reviewed-by: Taylor Blau Signed-off-by: Junio C Hamano --- .editorconfig | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 .editorconfig diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000000..8667740e1d --- /dev/null +++ b/.editorconfig @@ -0,0 +1,14 @@ +[*] +charset = utf-8 +insert_final_newline = true + +[*.{c,h,sh,perl,pl,pm}] +indent_style = tab +tab_width = 8 + +[*.py] +indent_style = space +indent_size = 4 + +[COMMIT_EDITMSG] +max_line_length = 72 From b548d698a0e42d28614acb6a0792d7cfbe7ddef4 Mon Sep 17 00:00:00 2001 From: "brian m. carlson" Date: Mon, 8 Oct 2018 22:03:53 +0000 Subject: [PATCH 2/2] editorconfig: indicate settings should be kept in sync Now that we have two places where we set code formatting settings, .editorconfig and .clang-format, it's possible that they could fall out of sync. This is relatively unlikely, since we're not likely to change the tab width or our preference for tabs, but just in case, add comments to both files reminding future developers to keep them in sync. Signed-off-by: brian m. carlson Reviewed-by: Taylor Blau Signed-off-by: Junio C Hamano --- .clang-format | 2 ++ .editorconfig | 2 ++ 2 files changed, 4 insertions(+) diff --git a/.clang-format b/.clang-format index 12a89f95f9..de1c8b5c77 100644 --- a/.clang-format +++ b/.clang-format @@ -6,6 +6,8 @@ # Use tabs whenever we need to fill whitespace that spans at least from one tab # stop to the next one. +# +# These settings are mirrored in .editorconfig. Keep them in sync. UseTab: Always TabWidth: 8 IndentWidth: 8 diff --git a/.editorconfig b/.editorconfig index 8667740e1d..42cdc4bbfb 100644 --- a/.editorconfig +++ b/.editorconfig @@ -2,6 +2,8 @@ charset = utf-8 insert_final_newline = true +# The settings for C (*.c and *.h) files are mirrored in .clang-format. Keep +# them in sync. [*.{c,h,sh,perl,pl,pm}] indent_style = tab tab_width = 8