Documentation: mention that `eol` can change the dirty status of paths
When setting the `eol` attribute, paths can change their dirty status without any change in the working directory. This can cause confusion and should at least be mentioned with a remedy. Signed-off-by: Ben Boeckel <mathstuf@gmail.com> Reviewed-by: Torsten Bögershausen <tboegi@web.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Ben Boeckel committed
Aug 31, 2017 at 09:19 UTC
3bc4b8f7c757059bb845b5074691362cece91c70
1 file changed
+4
-1
Documentation/gitattributes.txt
+4
-1
@@ -151,7 +151,10 @@ unspecified.
151
152
This attribute sets a specific line-ending style to be used in the
153
working directory. It enables end-of-line conversion without any
154
-content checks, effectively setting the `text` attribute.
154
+content checks, effectively setting the `text` attribute. Note that
155
+setting this attribute on paths which are in the index with CRLF line
156
+endings may make the paths to be considered dirty. Adding the path to
157
+the index again will normalize the line endings in the index.
158
159
Set to string value "crlf"::
160