git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Marc Strapetz <marc.strapetz@syntevo.com>
To: git@vger.kernel.org
Cc: sunshine@sunshineco.com
Subject: [PATCH v2] Documentation: declare "core.ignorecase" as internal variable
Date: Sun, 24 Jun 2018 12:44:26 +0200	[thread overview]
Message-ID: <aa841316-5fc0-b69b-a3d0-15911b0776f4@syntevo.com> (raw)
In-Reply-To: <7f6b2a42-334d-9443-7b89-625069931ca7@syntevo.com>

The current description of "core.ignoreCase" reads like an option which
is intended to be changed by the user while it's actually expected to
be set by Git on initialization only. This is especially important for
Git for Windows, as noted by Bryan Turner [1]:

     Git on Windows is not designed to run with anything other than
     core.ignoreCase=true, and attempting to do so will cause
     unexpected behavior. In other words, it's not a behavior toggle so
     user's can request the functionality to work one way or the other;
     it's an implementation detail that `git init` and `git clone` set
     when a repository is created purely so they don't have to probe
     the file system each time you run a `git` command.

[1] https://marc.info/?l=git&m=152972992729761&w=2

Signed-off-by: Marc Strapetz <marc.strapetz@syntevo.com>
---
  Documentation/config.txt | 4 ++--
  1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/config.txt b/Documentation/config.txt
index ab641bf5a..c25693828 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -390,7 +390,7 @@ core.hideDotFiles::
  	default mode is 'dotGitOnly'.

  core.ignoreCase::
-	If true, this option enables various workarounds to enable
+	Internal variable which enables various workarounds to enable
  	Git to work better on filesystems that are not case sensitive,
  	like FAT. For example, if a directory listing finds
  	"makefile" when Git expects "Makefile", Git will assume
@@ -399,7 +399,7 @@ core.ignoreCase::
  +
  The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
  will probe and set core.ignoreCase true if appropriate when the repository
-is created.
+is created. Modifying this value afterwards may result in unexpected 
behavior.

  core.precomposeUnicode::
  	This option is only used by Mac OS implementation of Git.
-- 
2.17.0.rc0.3.gb1b5a51b2

  parent reply	other threads:[~2018-06-24 10:44 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-06-24 10:05 [PATCH] Documentation: declare "core.ignorecase" as internal variable Marc Strapetz
2018-06-24 10:19 ` Eric Sunshine
2018-06-24 10:44 ` Marc Strapetz [this message]
2018-06-24 11:26   ` [PATCH v2] " Sascha Silbe
2018-06-24 13:47   ` Torsten Bögershausen
2018-06-26 21:50 ` [PATCH v3] " Marc Strapetz
2018-06-27 19:11   ` Junio C Hamano
2018-06-27 23:09     ` Aaron Schrab
2018-06-28 11:36     ` Marc Strapetz
2018-06-28 11:21 ` [PATCH v4] Documentation: declare "core.ignoreCase" " Marc Strapetz
2018-06-28 16:47   ` Junio C Hamano
2018-06-28 16:58   ` Torsten Bögershausen

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=aa841316-5fc0-b69b-a3d0-15911b0776f4@syntevo.com \
    --to=marc.strapetz@syntevo.com \
    --cc=git@vger.kernel.org \
    --cc=sunshine@sunshineco.com \
    /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).