Skip to content

Commit 48294b5

Browse files
mstrapgitster
authored andcommitted
Documentation: declare "core.ignoreCase" as internal variable
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. Subsequently, Git relies on the proper configuration of this variable, as noted by Bryan Turner [1]: Git on a case-insensitive filesystem (APFS, HFS+, FAT32, exFAT, vFAT, NTFS, etc.) is not designed to be run with anything other than core.ignoreCase=true. [1] https://marc.info/?l=git&m=152998665813997&w=2 mid:CAGyf7-GeE8jRGPkME9rHKPtHEQ6P1+ebpMMWAtMh01uO3bfy8w@mail.gmail.com Signed-off-by: Marc Strapetz <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent a42a58d commit 48294b5

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

Documentation/config.txt

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -390,16 +390,19 @@ core.hideDotFiles::
390390
default mode is 'dotGitOnly'.
391391

392392
core.ignoreCase::
393-
If true, this option enables various workarounds to enable
393+
Internal variable which enables various workarounds to enable
394394
Git to work better on filesystems that are not case sensitive,
395-
like FAT. For example, if a directory listing finds
396-
"makefile" when Git expects "Makefile", Git will assume
395+
like APFS, HFS+, FAT, NTFS, etc. For example, if a directory listing
396+
finds "makefile" when Git expects "Makefile", Git will assume
397397
it is really the same file, and continue to remember it as
398398
"Makefile".
399399
+
400400
The default is false, except linkgit:git-clone[1] or linkgit:git-init[1]
401401
will probe and set core.ignoreCase true if appropriate when the repository
402402
is created.
403+
+
404+
Git relies on the proper configuration of this variable for your operating
405+
and file system. Modifying this value may result in unexpected behavior.
403406

404407
core.precomposeUnicode::
405408
This option is only used by Mac OS implementation of Git.

0 commit comments

Comments
 (0)