summaryrefslogtreecommitdiff
path: root/.clang-format
diff options
context:
space:
mode:
authorStephan Beyer <s-beyer@gmx.net>2017-10-01 23:37:14 (GMT)
committerJunio C Hamano <gitster@pobox.com>2017-10-02 04:17:48 (GMT)
commit1bf0259a03d026ba4a8873aaf406d5b73512c4a3 (patch)
tree6d88d25f07ec29c35c3071545774371a6cee7fa8 /.clang-format
parent42efde4c299141ddf1ca5b63909b94ab3875aa14 (diff)
downloadgit-1bf0259a03d026ba4a8873aaf406d5b73512c4a3.zip
git-1bf0259a03d026ba4a8873aaf406d5b73512c4a3.tar.gz
git-1bf0259a03d026ba4a8873aaf406d5b73512c4a3.tar.bz2
clang-format: add a comment about the meaning/status of the
Having a .clang-format file in a project can be understood in a way that code has to be in the style defined by the .clang-format file, i.e., you just have to run clang-format over all code and you are set. This unfortunately is not yet the case in the Git project, as the format file is still work in progress. Explain it with a comment in the beginning of the file. Additionally, the working clang-format version is mentioned because the config directives change from time to time (in a compatibility-breaking way). Signed-off-by: Stephan Beyer <s-beyer@gmx.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to '.clang-format')
-rw-r--r--.clang-format6
1 files changed, 5 insertions, 1 deletions
diff --git a/.clang-format b/.clang-format
index 56822c1..611ab47 100644
--- a/.clang-format
+++ b/.clang-format
@@ -1,4 +1,8 @@
-# Defaults
+# This file is an example configuration for clang-format 5.0.
+#
+# Note that this style definition should only be understood as a hint
+# for writing new code. The rules are still work-in-progress and does
+# not yet exactly match the style we have in the existing code.
# Use tabs whenever we need to fill whitespace that spans at least from one tab
# stop to the next one.