From: Junio C Hamano <gitster@pobox.com>
Date: Wed, 13 Dec 2017 21:28:58 +0000 (-0800)
Subject: Merge branch 'jk/no-optional-locks'
X-Git-Tag: v2.16.0-rc0~55
X-Git-Url: https://git.lorimer.id.au/gitweb.git/diff_plain/e6bf6afe27d9a600963e8733ce17e7b067a4701c?ds=inline;hp=-c

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
---

e6bf6afe27d9a600963e8733ce17e7b067a4701c
diff --combined Documentation/git-status.txt
index fc282e0a92,23af8c6dc9..81cab9aefb
--- a/Documentation/git-status.txt
+++ b/Documentation/git-status.txt
@@@ -97,27 -97,8 +97,27 @@@ configuration variable documented in li
  	(and suppresses the output of submodule summaries when the config option
  	`status.submoduleSummary` is set).
  
 ---ignored::
 +--ignored[=<mode>]::
  	Show ignored files as well.
 ++
 +The mode parameter is used to specify the handling of ignored files.
 +It is optional: it defaults to 'traditional'.
 ++
 +The possible options are:
 ++
 +	- 'traditional' - Shows ignored files and directories, unless
 +			  --untracked-files=all is specifed, in which case
 +			  individual files in ignored directories are
 +			  displayed.
 +	- 'no'	        - Show no ignored files.
 +	- 'matching'    - Shows ignored files and directories matching an
 +			  ignore pattern.
 ++
 +When 'matching' mode is specified, paths that explicity match an
 +ignored pattern are shown. If a directory matches an ignore pattern,
 +then it is shown, but not paths contained in the ignored directory. If
 +a directory does not match an ignore pattern, but all contents are
 +ignored, then the directory is not shown, but all contents are shown.
  
  -z::
  	Terminate entries with NUL, instead of LF.  This implies
@@@ -130,8 -111,6 +130,8 @@@
  	without options are equivalent to 'always' and 'never'
  	respectively.
  
 +<pathspec>...::
 +	See the 'pathspec' entry in linkgit:gitglossary[7].
  
  OUTPUT
  ------
@@@ -387,6 -366,19 +387,19 @@@ ignored submodules you can either use t
  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]