]> git.ipfire.org Git - thirdparty/git.git/commitdiff
docs/config: clarify "text property" in core.eol
authorJeff King <peff@peff.net>
Tue, 29 Jan 2019 12:41:12 +0000 (07:41 -0500)
committerJunio C Hamano <gitster@pobox.com>
Tue, 29 Jan 2019 17:21:33 +0000 (09:21 -0800)
The word "property" is vague here. Let's spell out that we mean the path
must be marked with the text attribute.

While we're here, let's make the paragraph a little easier to read by
de-emphasizing the "when core.autocrlf is false" bit. Putting it in the
first sentence obscures the main content, and many readers won't care
about autocrlf (i.e., anyone who is just following the gitattributes(7)
advice, which mainly discusses "text" and "core.eol").

Helped-by: Torsten Bögershausen <tboegi@web.de>
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/config/core.txt

index d0e6635fe0b56b87826240bc80cfef40b722bef4..7e9b6c8f4c2d36116be6699c0dc822222393dae6 100644 (file)
@@ -121,11 +121,14 @@ core.quotePath::
 
 core.eol::
        Sets the line ending type to use in the working directory for
-       files that have the `text` property set when core.autocrlf is false.
+       files that are marked as text (either by having the `text`
+       attribute set, or by having `text=auto` and Git auto-detecting
+       the contents as text).
        Alternatives are 'lf', 'crlf' and 'native', which uses the platform's
        native line ending.  The default value is `native`.  See
        linkgit:gitattributes[5] for more information on end-of-line
-       conversion.
+       conversion. Note that this value is ignored if `core.autocrlf`
+       is set to `true` or `input`.
 
 core.safecrlf::
        If true, makes Git check if converting `CRLF` is reversible when