Documentation/git-status.txt

   1 git-status(1)
   2 =============
   3
   4 NAME
   5 ----
   6 git-status - Show the working tree status
   7
   8
   9 SYNOPSIS
  10 --------
  11 'git-status' <options>...
  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 add' 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 The command takes the same set of options as `git-commit`; it
  27 shows what would be committed if the same options are given to
  28 `git-commit`.
  29
  30 If any paths have been touched in the working tree (that is,
  31 their modification times have changed) but their contents and
  32 permissions are identical to those in the index file, the command
  33 updates the index file. Running `git-status` can thus speed up
  34 subsequent operations such as `git-diff` if the working tree
  35 contains many paths that have been touched but not modified.
  36
  37
  38 OUTPUT
  39 ------
  40 The output from this command is designed to be used as a commit
  41 template comments, and all the output lines are prefixed with '#'.
  42
  43 The paths mentioned in the output, unlike many other git commands, are
  44 made relative to the current directory, if you are working in a
  45 subdirectory (this is on purpose, to help cutting and pasting). See
  46 the status.relativePaths config option below.
  47
  48
  49 CONFIGURATION
  50 -------------
  51
  52 The command honors `color.status` (or `status.color` -- they
  53 mean the same thing and the latter is kept for backward
  54 compatibility) and `color.status.<slot>` configuration variables
  55 to colorize its output.
  56
  57 If the config variable `status.relativePaths` is set to false, then all
  58 paths shown are relative to the repository root, not to the current
  59 directory.
  60
  61 See Also
  62 --------
  63 gitlink:gitignore[5]
  64
  65 Author
  66 ------
  67 Written by Linus Torvalds <torvalds@osdl.org> and
  68 Junio C Hamano <junkio@cox.net>.
  69
  70 Documentation
  71 --------------
  72 Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
  73
  74 GIT
  75 ---
  76 Part of the gitlink:git[7] suite