summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorLibravatar brian m. carlson <sandals@crustytoothpaste.net>2022-02-14 10:15:43 -0800
committerLibravatar Junio C Hamano <gitster@pobox.com>2022-02-14 13:01:25 -0800
commit6a5678f2576dba579e35c6d86b02584abee0ac37 (patch)
tree909cd2532d66ba4fc4737a4fcaffc8820899abdd /Documentation
parentdocs: correct documentation about eol attribute (diff)
downloadtgif-6a5678f2576dba579e35c6d86b02584abee0ac37.tar.xz
doc: clarify interaction between 'eol' and text=auto
The `eol` takes effect on text files only when the index has the contents in LF line endings. Paths with contents in CRLF line endings in the index may become dirty unless text=auto. Signed-off-by: brian m. carlson <sandals@crustytoothpaste.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/gitattributes.txt11
1 files changed, 6 insertions, 5 deletions
diff --git a/Documentation/gitattributes.txt b/Documentation/gitattributes.txt
index 60984a4682..a71dad2674 100644
--- a/Documentation/gitattributes.txt
+++ b/Documentation/gitattributes.txt
@@ -161,11 +161,12 @@ unspecified.
This attribute sets a specific line-ending style to be used in the
working directory. This attribute has effect only if the `text`
-attribute is set or unspecified, or if it is set to `auto` and the file
-is detected as text. Note that setting this attribute on paths which
-are in the index with CRLF line endings may make the paths to be
-considered dirty. Adding the path to the index again will normalize the
-line endings in the index.
+attribute is set or unspecified, or if it is set to `auto`, the file is
+detected as text, and it is stored with LF endings in the index. Note
+that setting this attribute on paths which are in the index with CRLF
+line endings may make the paths to be considered dirty unless
+`text=auto` is set. Adding the path to the index again will normalize
+the line endings in the index.
Set to string value "crlf"::