Skip to content

Commit 9b73732

Browse files
committed
Merge branch 'nd/config-core-checkstat-doc'
The meaning of the possible values the "core.checkStat" configuration variable can take were not adequately documented, which has been fixed. * nd/config-core-checkstat-doc: config.txt: clarify core.checkStat
2 parents 29d9e3e + 9bf5d4c commit 9b73732

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

Documentation/config.txt

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -462,10 +462,20 @@ core.untrackedCache::
462462
See linkgit:git-update-index[1]. `keep` by default.
463463

464464
core.checkStat::
465-
Determines which stat fields to match between the index
466-
and work tree. The user can set this to 'default' or
467-
'minimal'. Default (or explicitly 'default'), is to check
468-
all fields, including the sub-second part of mtime and ctime.
465+
When missing or is set to `default`, many fields in the stat
466+
structure are checked to detect if a file has been modified
467+
since Git looked at it. When this configuration variable is
468+
set to `minimal`, sub-second part of mtime and ctime, the
469+
uid and gid of the owner of the file, the inode number (and
470+
the device number, if Git was compiled to use it), are
471+
excluded from the check among these fields, leaving only the
472+
whole-second part of mtime (and ctime, if `core.trustCtime`
473+
is set) and the filesize to be checked.
474+
+
475+
There are implementations of Git that do not leave usable values in
476+
some fields (e.g. JGit); by excluding these fields from the
477+
comparison, the `minimal` mode may help interoperability when the
478+
same repository is used by these other systems at the same time.
469479

470480
core.quotePath::
471481
Commands that output paths (e.g. 'ls-files', 'diff'), will

0 commit comments

Comments
 (0)