summaryrefslogtreecommitdiff
path: root/Documentation/git-status.txt
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2013-03-21 21:02:10 (GMT)
committerJunio C Hamano <gitster@pobox.com>2013-03-21 21:02:10 (GMT)
commit5d04924e1914a0c63b6467b8cb7194bf68c003cb (patch)
tree8b25ce5850f7ec792c6c69972584eec2f9062174 /Documentation/git-status.txt
parent03da85b954507749af01545888a20b7643761d58 (diff)
parent6a38ef2ced55f0a8a7967581934e40f79e1d8733 (diff)
downloadgit-5d04924e1914a0c63b6467b8cb7194bf68c003cb.zip
git-5d04924e1914a0c63b6467b8cb7194bf68c003cb.tar.gz
git-5d04924e1914a0c63b6467b8cb7194bf68c003cb.tar.bz2
Merge branch 'tb/document-status-u-tradeoff'
Suggest users to look into using--untracked=no option when "git status" takes too long. * tb/document-status-u-tradeoff: status: advise to consider use of -u when read_directory takes too long git status: document trade-offs in choosing parameters to the -u option
Diffstat (limited to 'Documentation/git-status.txt')
-rw-r--r--Documentation/git-status.txt14
1 files changed, 10 insertions, 4 deletions
diff --git a/Documentation/git-status.txt b/Documentation/git-status.txt
index 0412c40..9046df9 100644
--- a/Documentation/git-status.txt
+++ b/Documentation/git-status.txt
@@ -46,15 +46,21 @@ OPTIONS
Show untracked files.
+
The mode parameter is optional (defaults to 'all'), and is used to
-specify the handling of untracked files; when -u is not used, the
-default is 'normal', i.e. show untracked files and directories.
+specify the handling of untracked files.
+
The possible options are:
+
- - 'no' - Show no untracked files
- - 'normal' - Shows untracked files and directories
+ - 'no' - Show no untracked files.
+ - 'normal' - Shows untracked files and 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
configuration variable documented in linkgit:git-config[1].