]> git.ipfire.org Git - thirdparty/git.git/commit
gitfaq: give advice on using eol attribute in gitattributes
authorbrian m. carlson <sandals@crustytoothpaste.net>
Tue, 9 Jul 2024 23:37:44 +0000 (23:37 +0000)
committerJunio C Hamano <gitster@pobox.com>
Wed, 10 Jul 2024 04:24:42 +0000 (21:24 -0700)
commitc98f78b806c93560c2a6c7eadda5449ac2a5432b
tree5b0aad685ae97cffaa22a1c659cd7b9eb0f97825
parent2101341484b093a7324ef8cd408af52c73cc5bea
gitfaq: give advice on using eol attribute in gitattributes

In the FAQ, we tell people how to use the text attribute, but we fail to
explain what to do with the eol attribute.  As we ourselves have
noticed, most shell implementations do not care for carriage returns,
and as such, people will practically always want them to use LF endings.
Similar things can be said for batch files on Windows, except with CRLF
endings.

Since these are common things to have in a repository, let's help users
make a good decision by recommending that they use the gitattributes
file to correctly check out the endings.

In addition, let's correct the cross-reference to this question, which
originally referred to "the following entry", even though a new entry
has been inserted in between.  The cross-reference notation should
prevent this from occurring and provide a link in formats, such as HTML,
which support that.

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