git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Jeff King <peff@peff.net>
To: "Torsten Bögershausen" <tboegi@web.de>
Cc: Junio C Hamano <gitster@pobox.com>,
	Sergey Lukashev <lukashev.s@ya.ru>,
	"git@vger.kernel.org" <git@vger.kernel.org>
Subject: [PATCH v2 2/2] docs/config: clarify "text property" in core.eol
Date: Tue, 29 Jan 2019 07:41:12 -0500	[thread overview]
Message-ID: <20190129124112.GB21931@sigill.intra.peff.net> (raw)
In-Reply-To: <20190129124031.GA13084@sigill.intra.peff.net>

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>
---
 Documentation/config/core.txt | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/Documentation/config/core.txt b/Documentation/config/core.txt
index d0e6635fe0..7e9b6c8f4c 100644
--- a/Documentation/config/core.txt
+++ b/Documentation/config/core.txt
@@ -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
-- 
2.20.1.845.g57b86ca485

  parent reply	other threads:[~2019-01-29 12:41 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-01-27  9:58 unclear docs Sergey Lukashev
2019-01-27 11:55 ` Sergey Lukashev
2019-01-28 16:09   ` Jeff King
2019-01-28 18:12     ` Sergey Lukashev
2019-01-28 18:31       ` Jeff King
2019-01-29  7:38         ` Torsten Bögershausen
2019-01-29 10:28           ` Sergey Lukashev
2019-01-29 12:40           ` [PATCH v2 0/2] eol/autocrlf doc clarifications Jeff King
2019-01-29 12:41             ` [PATCH v2 1/2] doc/gitattributes: clarify "autocrlf overrides eol" Jeff King
2019-01-29 12:41             ` Jeff King [this message]
2019-01-28 17:31   ` unclear docs Torsten Bögershausen
2019-01-28 16:06 ` Jeff King
2019-01-28 18:30   ` Junio C Hamano
2019-01-28 18:32     ` Jeff King
2019-01-28 20:16       ` Sergey Lukashev
2019-01-28 20:46         ` Jeff King

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20190129124112.GB21931@sigill.intra.peff.net \
    --to=peff@peff.net \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=lukashev.s@ya.ru \
    --cc=tboegi@web.de \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).