Skip to content

Commit e6bf6af

Browse files
committed
Merge branch 'jk/no-optional-locks'
Doc update for a feature available in Git v2.14 and upwards. * jk/no-optional-locks: git-status.txt: mention --no-optional-locks
2 parents 97e1f85 + 5e83cca commit e6bf6af

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

Documentation/git-status.txt

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -387,6 +387,19 @@ ignored submodules you can either use the --ignore-submodules=dirty command
387387
line option or the 'git submodule summary' command, which shows a similar
388388
output but does not honor these settings.
389389

390+
BACKGROUND REFRESH
391+
------------------
392+
393+
By default, `git status` will automatically refresh the index, updating
394+
the cached stat information from the working tree and writing out the
395+
result. Writing out the updated index is an optimization that isn't
396+
strictly necessary (`status` computes the values for itself, but writing
397+
them out is just to save subsequent programs from repeating our
398+
computation). When `status` is run in the background, the lock held
399+
during the write may conflict with other simultaneous processes, causing
400+
them to fail. Scripts running `status` in the background should consider
401+
using `git --no-optional-locks status` (see linkgit:git[1] for details).
402+
390403
SEE ALSO
391404
--------
392405
linkgit:gitignore[5]

0 commit comments

Comments
 (0)