Merge branch 'jc/maint-add-sync-stat' into maint
[gitweb.git] / Documentation / git-status.txt
index 89a4f38203394b198208d0a3317e5494180d6cea..8fd0fc62368611bee25b4bbc3becef853937ff2c 100644 (file)
@@ -3,19 +3,19 @@ git-status(1)
 
 NAME
 ----
-git-status - Show working tree status.
+git-status - Show the working tree status
 
 
 SYNOPSIS
 --------
-'git status'
+'git-status' <options>...
 
 DESCRIPTION
 -----------
 Examines paths in the working tree that has changes unrecorded
 to the index file, and changes between the index file and the
 current HEAD commit.  The former paths are what you _could_
-commit by running 'git-update-index' before running 'git
+commit by running 'git add' before running 'git
 commit', and the latter paths are what you _would_ commit by
 running 'git commit'.
 
@@ -23,6 +23,17 @@ If there is no path that is different between the index file and
 the current HEAD commit, the command exits with non-zero
 status.
 
+The command takes the same set of options as `git-commit`; it
+shows what would be committed if the same options are given to
+`git-commit`.
+
+If any paths have been touched in the working tree (that is,
+their modification times have changed) but their contents and
+permissions are identical to those in the index file, the command
+updates the index file. Running `git-status` can thus speed up
+subsequent operations such as `git-diff` if the working tree
+contains many paths that have been touched but not modified.
+
 
 OUTPUT
 ------
@@ -30,6 +41,18 @@ The output from this command is designed to be used as a commit
 template comments, and all the output lines are prefixed with '#'.
 
 
+CONFIGURATION
+-------------
+
+The command honors `color.status` (or `status.color` -- they
+mean the same thing and the latter is kept for backward
+compatibility) and `color.status.<slot>` configuration variables
+to colorize its output.
+
+See Also
+--------
+gitlink:gitignore[5]
+
 Author
 ------
 Written by Linus Torvalds <torvalds@osdl.org> and
@@ -42,4 +65,3 @@ Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel
 GIT
 ---
 Part of the gitlink:git[7] suite
-