Documentation/git-status.txt

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