Add comments to .gitattributes

ideoforms · Dec 3, 2023 · 75afa43 · 75afa43
1 parent eec1a7b
commit 75afa43
Showing 1 changed file with 10 additions and 3 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -1,5 +1,12 @@
-# To set up clang-format filter:
-# git config --global filter.clang-format.clean clang-format
-# git config --global filter.clang-format.smudge cat
+#--------------------------------------------------------------------------------
+# Configure clean and smudge filters to apply when checking code in and out
+# of git respectively.
+#
+# To use these rules, the clang-format filter must be first be set up adding 
+# to .gitconfig:
+#
+#   git config --global filter.clang-format.clean clang-format
+#   git config --global filter.clang-format.smudge cat
+#--------------------------------------------------------------------------------
 *.cpp filter=clang-format
 *.h filter=clang-format