docs/config: clarify "text property" in core.eol
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>
Jeff King committed
Jan 29, 2019 at 07:41 UTC
c9446f0504e4b785758eed0b63c7e00c1b7091ba
1 file changed
+5
-2
Documentation/config/core.txt
+5
-2
@@ -121,11 +121,14 @@ core.quotePath::
121
122
core.eol::
123
Sets the line ending type to use in the working directory for
124
- files that have the `text` property set when core.autocrlf is false.
124
+ files that are marked as text (either by having the `text`
125
+ attribute set, or by having `text=auto` and Git auto-detecting
126
+ the contents as text).
127
Alternatives are 'lf', 'crlf' and 'native', which uses the platform's
128
native line ending. The default value is `native`. See
129
linkgit:gitattributes[5] for more information on end-of-line
128
- conversion.
130
+ conversion. Note that this value is ignored if `core.autocrlf`
131
+ is set to `true` or `input`.
132
133
core.safecrlf::
134
If true, makes Git check if converting `CRLF` is reversible when