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 Displays paths that have differences between the index file and the
  16 current HEAD commit, paths that have differences between the working
  17 tree and the index file, and paths in the working tree that are not
  18 tracked by git (and are not ignored by linkgit:gitignore[5]). The first
  19 are what you _would_ commit by running `git commit`; the second and
  20 third are what you _could_ commit by running `git add` before running
  21 `git commit`.
  22
  23 The command takes the same set of options as `git-commit`; it
  24 shows what would be committed if the same options are given to
  25 `git-commit`.
  26
  27 If there is no path that is different between the index file and
  28 the current HEAD commit (i.e., there is nothing to commit by running
  29 `git-commit`), the command exits with non-zero status.
  30
  31
  32 OUTPUT
  33 ------
  34 The output from this command is designed to be used as a commit
  35 template comment, and all the output lines are prefixed with '#'.
  36
  37 The paths mentioned in the output, unlike many other git commands, are
  38 made relative to the current directory if you are working in a
  39 subdirectory (this is on purpose, to help cutting and pasting). See
  40 the status.relativePaths config option below.
  41
  42
  43 CONFIGURATION
  44 -------------
  45
  46 The command honors `color.status` (or `status.color` -- they
  47 mean the same thing and the latter is kept for backward
  48 compatibility) and `color.status.<slot>` configuration variables
  49 to colorize its output.
  50
  51 If the config variable `status.relativePaths` is set to false, then all
  52 paths shown are relative to the repository root, not to the current
  53 directory.
  54
  55 If `status.submodulesummary` is set to a non zero number or true (identical
  56 to -1 or an unlimited number), the submodule summary will be enabled and a
  57 summary of commits for modified submodules will be shown (see --summary-limit
  58 option of linkgit:git-submodule[1]).
  59
  60 SEE ALSO
  61 --------
  62 linkgit:gitignore[5]
  63
  64 Author
  65 ------
  66 Written by Linus Torvalds <torvalds@osdl.org> and
  67 Junio C Hamano <junkio@cox.net>.
  68
  69 Documentation
  70 --------------
  71 Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
  72
  73 GIT
  74 ---
  75 Part of the linkgit:git[1] suite