git status: document trade-offs in choosing parameters to the -u option

In some repostories users experience that "git status" command takes
long time.  The command spends some time searching the file system
for untracked files.

Explain the trade-off struck by the default choice of `normal` to
help users make an appropriate choice better, before talking about
the configuration variable.

Inspired by Torsten Bögershausen.

Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Junio C Hamano 2013-03-15 09:53:48 -07:00
Родитель 15999998fb
Коммит 5823eb2b28
1 изменённых файлов: 10 добавлений и 4 удалений

Просмотреть файл

@ -43,15 +43,21 @@ OPTIONS
Show untracked files. Show untracked files.
+ +
The mode parameter is optional (defaults to 'all'), and is used to The mode parameter is optional (defaults to 'all'), and is used to
specify the handling of untracked files; when -u is not used, the specify the handling of untracked files.
default is 'normal', i.e. show untracked files and directories.
+ +
The possible options are: The possible options are:
+ +
- 'no' - Show no untracked files - 'no' - Show no untracked files.
- 'normal' - Shows untracked files and directories - 'normal' - Shows untracked files and directories.
- 'all' - Also shows individual files in untracked directories. - 'all' - Also shows individual files in untracked directories.
+ +
When `-u` option is not used, untracked files and directories are
shown (i.e. the same as specifying `normal`), to help you avoid
forgetting to add newly created files. Because it takes extra work
to find untracked files in the filesystem, this mode may take some
time in a large working tree. You can use `no` to have `git status`
return more quickly without showing untracked files.
+
The default can be changed using the status.showUntrackedFiles The default can be changed using the status.showUntrackedFiles
configuration variable documented in linkgit:git-config[1]. configuration variable documented in linkgit:git-config[1].