]> git.ipfire.org Git - thirdparty/git.git/commit
docs: correct documentation about eol attribute
authorbrian m. carlson <sandals@crustytoothpaste.net>
Tue, 11 Jan 2022 02:15:07 +0000 (02:15 +0000)
committerJunio C Hamano <gitster@pobox.com>
Wed, 12 Jan 2022 18:22:22 +0000 (10:22 -0800)
commit8c591dbfcef9b4d40cfae7f675a2c99a0e925157
treea2b7ea031aba78d4e5dc4393f52b6e563d588772
parentab961513c4a6bb1d65636829aa962593cfd934e9
docs: correct documentation about eol attribute

The documentation for the eol attribute states that it is "effectively
setting the text attribute".  However, this implies that it forces the
text attribute to always be set, which has not been the case since
6523728499 ("convert: unify the "auto" handling of CRLF", 2016-06-28).
Let's avoid confusing users (and the present author when trying to
describe Git's behavior to others) by clearly documenting in which
cases the "eol" attribute has effect.

Specifically, the attribute always has an effect unless the file is
explicitly set as -text, or the file is set as text=auto and the file is
detected as binary.

Signed-off-by: brian m. carlson <sandals@crustytoothpaste.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/gitattributes.txt