Merge http://www.kernel.org/pub/scm/gitk/gitk
[git/git.git] / Documentation / git-status.txt
1 git-status(1)
2 =============
3
4 NAME
5 ----
6 git-status - Show working tree status.
7
8
9 SYNOPSIS
10 --------
11 'git-status'
12
13 DESCRIPTION
14 -----------
15 Examines paths in the working tree that has changes unrecorded
16 to the index file, and changes between the index file and the
17 current HEAD commit. The former paths are what you _could_
18 commit by running 'git-update-index' before running 'git
19 commit', and the latter paths are what you _would_ commit by
20 running 'git commit'.
21
22 If there is no path that is different between the index file and
23 the current HEAD commit, the command exits with non-zero
24 status.
25
26
27 OUTPUT
28 ------
29 The output from this command is designed to be used as a commit
30 template comments, and all the output lines are prefixed with '#'.
31
32
33 Author
34 ------
35 Written by Linus Torvalds <torvalds@osdl.org> and
36 Junio C Hamano <junkio@cox.net>.
37
38 Documentation
39 --------------
40 Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
41
42 GIT
43 ---
44 Part of the gitlink:git[7] suite
45