doc: core.ignoreStat update, and clarify the --assume-unchanged effect
The assume-unchanged bit, and consequently core.ignoreStat, can be misunderstood. Be assertive about the expectation that file changes should notified to Git. Overhaul the general wording thus: 1. direct description of what is ignored given first. 2. example instruction of the user manual action required. 3. use sideways indirection for assume-unchanged and update-index references. 4. add a 'normally' to give leeway for the change detection. Signed-off-by: Philip Oakley <philipoakley@iee.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Philip Oakley committed
Jan 5, 2015 at 22:22 UTC
92be938e96508a87fa2b0b78bd335fc6273f5763
1 file changed
+13
-9
Documentation/config.txt
+13
-9
@@ -364,15 +364,19 @@ This is useful for excluding servers inside a firewall from
364
proxy use, while defaulting to a common proxy for external domains.
365
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 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.
367
+ If true, Git will avoid using lstat() calls to detect if files have
368
+ changed by setting the "assume-unchanged" bit for those tracked files
369
+ which it has updated identically in both the index and working tree.
370
++
371
+When files are modified outside of Git, the user will need to stage
372
+the modified files explicitly (e.g. see 'Examples' section in
373
+linkgit:git-update-index[1]).
374
+Git will not normally detect changes to those files.
375
++
376
+This is useful on systems where lstat() calls are very slow, such as
377
+CIFS/Microsoft Windows.
378
++
379
+False by default.
380
381
core.preferSymlinkRefs::
382
Instead of the default "symref" format for HEAD