Re: unclear docs
- Date: Mon, 28 Jan 2019 13:31:17 -0500
- From: Jeff King <peff@xxxxxxxx>
- Subject: Re: unclear docs
On Mon, Jan 28, 2019 at 09:12:00PM +0300, Sergey Lukashev wrote:
> Thank you. Does the paragraph about core.eol refers to the text
> attribute? It's written 'property' there. I was thinking it means
> whether git thinks file is text, using .gitattributes OR otherwise.
> Maybe changing this word will make it clearer?
Yeah, I think the word "property" is unnecessarily confusing. Here's
another patch (meant to go on top of the other).
-- >8 --
Subject: [PATCH] docs/config: clarify "text property" in core.eol
The word "property" is less clear than "attribute", which is used
elsewhere in the (surprise!) gitattributes documentation. So let's use
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").
Signed-off-by: Jeff King <peff@xxxxxxxx>
Documentation/config/core.txt | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/Documentation/config/core.txt b/Documentation/config/core.txt
index d0e6635fe0..69c73ffe30 100644
@@ -121,11 +121,12 @@ core.quotePath::
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 have the `text` attribute.
Alternatives are 'lf', 'crlf' and 'native', which uses the platform's
native line ending. The default value is `native`. See
linkgit:gitattributes for more information on end-of-line
+ conversion. Note that this value is ignored if `core.autocrlf`
+ is set to `true`.
If true, makes Git check if converting `CRLF` is reversible when