doc: core.ignoreStat clarify the --assume-unchanged effect

The assume-unchanged bit can be misunderstood. Be assertive about the expectation that file changes should update that flag. Signed-off-by: Philip Oakley <philipoakley@iee.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Philip Oakley committed Dec 11, 2014 at 23:48 UTC 1be976eeb4232a1b09aeb63f863646d30d31decd
1 file changed +5 -4
Documentation/config.txt
+5 -4
@@ -366,10 +366,11 @@ proxy use, while defaulting to a common proxy for external domains.
366 core.ignoreStat::
367 If true, commands which modify both the working tree and the index
368 will mark the updated paths with the "assume unchanged" bit in the
369 - index. These marked files are then assumed to stay unchanged in the
370 - working tree, until you mark them otherwise manually - Git will not
371 - detect the file changes by lstat() calls. This is useful on systems
372 - where those are very slow, such as Microsoft Windows.
369 + index. These marked files are then expected to stay unchanged in the
370 + working tree. If you change them you should mark their update manually.
371 + Git will normally not detect the file changes by lstat() calls.
372 + This is useful on systems where those calls are very slow, such as
373 + cifs/Microsoft Windows.
374 See linkgit:git-update-index[1].
375 False by default.
376