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 <sandals@crustytoothpaste.net>
Reviewed-by: Taylor Blau <me@ttaylorr.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/.clang-format b/.clang-format
index 12a89f95f993546888410613458c9385b16f0108..de1c8b5c77f7566d9e41949e5e397db3cc1b487c 100644 (file)
--- 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 8667740e1d73c852921b77dd917be1db1a4bb693..42cdc4bbfb05934bb9c3ed2fe0e0d45212c32d7a 100644 (file)
--- 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