git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Will Palmer <wmpalmer@gmail.com>
To: git@vger.kernel.org
Cc: wmpalmer@gmail.com
Subject: [PATCH] make description of "core.autocrlf" less ambiguous
Date: Wed, 14 Apr 2010 00:23:23 +0100	[thread overview]
Message-ID: <1271201003-3413-1-git-send-email-wmpalmer@gmail.com> (raw)

The description for core.autocrlf refers to reads from / writes to the
"filesystem". While the term is used elsewhere in the config
documentation to refer to the filesystem git is hosted on, it is not
only less clear from context in the case of core.autocrlf, but can also
be plain inaccurate in many cases.

To make more clear the direction of removal / addition of CR when
core.crlf is set, as well as to account for the usage of low-level
commands such as hash-object or cat-file, we change "reading from the
filesystem" to refer instead to "writing to the object database", and
"writing to the filesystem" to "output or writing to the work tree"

Signed-off-by: Will Palmer <wmpalmer@gmail.com>
---

While I did some simple checks to ensure that my basic assumptions about
how the commands I use daily seem to interact with core.autocrlf, I'll
easily admit that I don't actually know all the places autocrlf is
referenced, so I could be completely wrong about what generalizations
can actually be made in the documentation.
I'm fine with this patch being included, but it's pretty much just me
"being bold" in order to say that I think the way it's currently
phrased is wrong and confusing.

 Documentation/config.txt |   10 +++++-----
 1 files changed, 5 insertions(+), 5 deletions(-)

diff --git a/Documentation/config.txt b/Documentation/config.txt
index 626b19a..125e9d5 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -198,11 +198,11 @@ core.quotepath::
 
 core.autocrlf::
 	If true, makes git convert `CRLF` at the end of lines in text files to
-	`LF` when reading from the filesystem, and convert in reverse when
-	writing to the filesystem.  The variable can be set to
-	'input', in which case the conversion happens only while
-	reading from the filesystem but files are written out with
-	`LF` at the end of lines.  A file is considered
+	`LF` when writing into the object database, and convert in reverse when
+	outputting those files or writing them to the work tree.  The variable
+	can be set to 'input', in which case the conversion happens only while
+	writing into the object database, but files are output and written to the
+	work tree with `LF` at the end of lines.  A file is considered
 	"text" (i.e. be subjected to the autocrlf mechanism) based on
 	the file's `crlf` attribute, or if `crlf` is unspecified,
 	based on the file's contents.  See linkgit:gitattributes[5].
-- 
1.7.1.rc1.248.gcefbb

             reply	other threads:[~2010-04-13 23:23 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-04-13 23:23 Will Palmer [this message]
2010-04-14 13:55 ` [PATCH] make description of "core.autocrlf" less ambiguous Junio C Hamano
2010-04-14 14:49   ` Will Palmer

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

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

  git send-email \
    --in-reply-to=1271201003-3413-1-git-send-email-wmpalmer@gmail.com \
    --to=wmpalmer@gmail.com \
    --cc=git@vger.kernel.org \
    /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.
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 NNTP newsgroup(s).