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>...] [--] [<pathspec>...]
  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 OPTIONS
  24 -------
  25
  26 -s::
  27 --short::
  28         Give the output in the short-format.
  29
  30 -b::
  31 --branch::
  32         Show the branch and tracking info even in short-format.
  33
  34 --porcelain::
  35         Give the output in a stable, easy-to-parse format for scripts.
  36         Currently this is identical to --short output, but is guaranteed
  37         not to change in the future, making it safe for scripts.
  38
  39 -u[<mode>]::
  40 --untracked-files[=<mode>]::
  41         Show untracked files.
  42 +
  43 The mode parameter is optional (defaults to 'all'), and is used to
  44 specify the handling of untracked files; when -u is not used, the
  45 default is 'normal', i.e. show untracked files and directories.
  46 +
  47 The possible options are:
  48 +
  49         - 'no'     - Show no untracked files
  50         - 'normal' - Shows untracked files and directories
  51         - 'all'    - Also shows individual files in untracked directories.
  52 +
  53 The default can be changed using the status.showUntrackedFiles
  54 configuration variable documented in linkgit:git-config[1].
  55
  56 --ignore-submodules[=<when>]::
  57         Ignore changes to submodules when looking for changes. <when> can be
  58         either "none", "untracked", "dirty" or "all", which is the default.
  59         Using "none" will consider the submodule modified when it either contains
  60         untracked or modified files or its HEAD differs from the commit recorded
  61         in the superproject and can be used to override any settings of the
  62         'ignore' option in linkgit:git-config[1] or linkgit:gitmodules[5]. When
  63         "untracked" is used submodules are not considered dirty when they only
  64         contain untracked content (but they are still scanned for modified
  65         content). Using "dirty" ignores all changes to the work tree of submodules,
  66         only changes to the commits stored in the superproject are shown (this was
  67         the behavior before 1.7.0). Using "all" hides all changes to submodules
  68         (and suppresses the output of submodule summaries when the config option
  69         `status.submodulesummary` is set).
  70
  71 -z::
  72         Terminate entries with NUL, instead of LF.  This implies
  73         the `--porcelain` output format if no other format is given.
  74
  75
  76 OUTPUT
  77 ------
  78 The output from this command is designed to be used as a commit
  79 template comment, and all the output lines are prefixed with '#'.
  80 The default, long format, is designed to be human readable,
  81 verbose and descriptive.  Its contents and format are subject to change
  82 at any time.
  83
  84 The paths mentioned in the output, unlike many other git commands, are
  85 made relative to the current directory if you are working in a
  86 subdirectory (this is on purpose, to help cutting and pasting). See
  87 the status.relativePaths config option below.
  88
  89 In the short-format, the status of each path is shown as
  90
  91         XY PATH1 -> PATH2
  92
  93 where `PATH1` is the path in the `HEAD`, and the ` -> PATH2` part is
  94 shown only when `PATH1` corresponds to a different path in the
  95 index/worktree (i.e. the file is renamed). The 'XY' is a two-letter
  96 status code.
  97
  98 The fields (including the `->`) are separated from each other by a
  99 single space. If a filename contains whitespace or other nonprintable
 100 characters, that field will be quoted in the manner of a C string
 101 literal: surrounded by ASCII double quote (34) characters, and with
 102 interior special characters backslash-escaped.
 103
 104 For paths with merge conflicts, `X` and 'Y' show the modification
 105 states of each side of the merge. For paths that do not have merge
 106 conflicts, `X` shows the status of the index, and `Y` shows the status
 107 of the work tree.  For untracked paths, `XY` are `??`.  Other status
 108 codes can be interpreted as follows:
 109
 110 * ' ' = unmodified
 111 * 'M' = modified
 112 * 'A' = added
 113 * 'D' = deleted
 114 * 'R' = renamed
 115 * 'C' = copied
 116 * 'U' = updated but unmerged
 117
 118 Ignored files are not listed.
 119
 120     X          Y     Meaning
 121     -------------------------------------------------
 122               [MD]   not updated
 123     M        [ MD]   updated in index
 124     A        [ MD]   added to index
 125     D         [ M]   deleted from index
 126     R        [ MD]   renamed in index
 127     C        [ MD]   copied in index
 128     [MARC]           index and work tree matches
 129     [ MARC]     M    work tree changed since index
 130     [ MARC]     D    deleted in work tree
 131     -------------------------------------------------
 132     D           D    unmerged, both deleted
 133     A           U    unmerged, added by us
 134     U           D    unmerged, deleted by them
 135     U           A    unmerged, added by them
 136     D           U    unmerged, deleted by us
 137     A           A    unmerged, both added
 138     U           U    unmerged, both modified
 139     -------------------------------------------------
 140     ?           ?    untracked
 141     -------------------------------------------------
 142
 143 If -b is used the short-format status is preceded by a line
 144
 145 ## branchname tracking info
 146
 147 There is an alternate -z format recommended for machine parsing.  In
 148 that format, the status field is the same, but some other things
 149 change.  First, the '->' is omitted from rename entries and the field
 150 order is reversed (e.g 'from -> to' becomes 'to from'). Second, a NUL
 151 (ASCII 0) follows each filename, replacing space as a field separator
 152 and the terminating newline (but a space still separates the status
 153 field from the first filename).  Third, filenames containing special
 154 characters are not specially formatted; no quoting or
 155 backslash-escaping is performed. Fourth, there is no branch line.
 156
 157 CONFIGURATION
 158 -------------
 159
 160 The command honors `color.status` (or `status.color` -- they
 161 mean the same thing and the latter is kept for backward
 162 compatibility) and `color.status.<slot>` configuration variables
 163 to colorize its output.
 164
 165 If the config variable `status.relativePaths` is set to false, then all
 166 paths shown are relative to the repository root, not to the current
 167 directory.
 168
 169 If `status.submodulesummary` is set to a non zero number or true (identical
 170 to -1 or an unlimited number), the submodule summary will be enabled for
 171 the long format and a summary of commits for modified submodules will be
 172 shown (see --summary-limit option of linkgit:git-submodule[1]).
 173
 174 SEE ALSO
 175 --------
 176 linkgit:gitignore[5]
 177
 178 GIT
 179 ---
 180 Part of the linkgit:git[1] suite