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