diff options
| author | Junio C Hamano <gitster@pobox.com> | 2017-12-13 13:28:58 -0800 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2017-12-13 13:28:58 -0800 |
| commit | e6bf6afe27d9a600963e8733ce17e7b067a4701c (patch) | |
| tree | c63b6908c9070c2f8e6eb23b5a71fa3f9b285020 | |
| parent | 97e1f857fc8c7a9ba2b1179d58cc2b6b68a88437 (diff) | |
| parent | 5e83cca0b83b4a915f9ed246c2bcfeeb5a58b86b (diff) | |
| download | git-e6bf6afe27d9a600963e8733ce17e7b067a4701c.tar.gz | |
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
| -rw-r--r-- | Documentation/git-status.txt | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/Documentation/git-status.txt b/Documentation/git-status.txt index fc282e0a92..81cab9aefb 100644 --- a/Documentation/git-status.txt +++ b/Documentation/git-status.txt @@ -387,6 +387,19 @@ ignored submodules you can either use the --ignore-submodules=dirty command line option or the 'git submodule summary' command, which shows a similar output but does not honor these settings. +BACKGROUND REFRESH +------------------ + +By default, `git status` will automatically refresh the index, updating +the cached stat information from the working tree and writing out the +result. Writing out the updated index is an optimization that isn't +strictly necessary (`status` computes the values for itself, but writing +them out is just to save subsequent programs from repeating our +computation). When `status` is run in the background, the lock held +during the write may conflict with other simultaneous processes, causing +them to fail. Scripts running `status` in the background should consider +using `git --no-optional-locks status` (see linkgit:git[1] for details). + SEE ALSO -------- linkgit:gitignore[5] |