Skip to content

Commit 1bf0259

Browse files
sbeyergitster
authored andcommitted
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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 42efde4 commit 1bf0259

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

.clang-format

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
# Defaults
1+
# This file is an example configuration for clang-format 5.0.
2+
#
3+
# Note that this style definition should only be understood as a hint
4+
# for writing new code. The rules are still work-in-progress and does
5+
# not yet exactly match the style we have in the existing code.
26

37
# Use tabs whenever we need to fill whitespace that spans at least from one tab
48
# stop to the next one.

0 commit comments

Comments
 (0)