summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2018-08-27 21:33:42 (GMT)
committerJunio C Hamano <gitster@pobox.com>2018-08-27 21:33:42 (GMT)
commit9b7373257740e2eeeb6593261f4af29caba2ba9f (patch)
tree7e4581106a850363567a62e5c0ed5efb9f162812
parent29d9e3e2c47dd4b5053b0a98c891878d398463e3 (diff)
parent9bf5d4c4e22fce46f87e576b2ae09982e926bfc5 (diff)
downloadgit-9b7373257740e2eeeb6593261f4af29caba2ba9f.zip
git-9b7373257740e2eeeb6593261f4af29caba2ba9f.tar.gz
git-9b7373257740e2eeeb6593261f4af29caba2ba9f.tar.bz2
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
-rw-r--r--Documentation/config.txt18
1 files changed, 14 insertions, 4 deletions
diff --git a/Documentation/config.txt b/Documentation/config.txt
index 1c42364..136a345 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -462,10 +462,20 @@ core.untrackedCache::
See linkgit:git-update-index[1]. `keep` by default.
core.checkStat::
- Determines which stat fields to match between the index
- and work tree. The user can set this to 'default' or
- 'minimal'. Default (or explicitly 'default'), is to check
- all fields, including the sub-second part of mtime and ctime.
+ When missing or is set to `default`, many fields in the stat
+ structure are checked to detect if a file has been modified
+ since Git looked at it. When this configuration variable is
+ set to `minimal`, sub-second part of mtime and ctime, the
+ uid and gid of the owner of the file, the inode number (and
+ the device number, if Git was compiled to use it), are
+ excluded from the check among these fields, leaving only the
+ whole-second part of mtime (and ctime, if `core.trustCtime`
+ is set) and the filesize to be checked.
++
+There are implementations of Git that do not leave usable values in
+some fields (e.g. JGit); by excluding these fields from the
+comparison, the `minimal` mode may help interoperability when the
+same repository is used by these other systems at the same time.
core.quotePath::
Commands that output paths (e.g. 'ls-files', 'diff'), will