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 --show-stash::
  36         Show the number of entries currently stashed away.
  37
  38 --porcelain[=<version>]::
  39         Give the output in an easy-to-parse format for scripts.
  40         This is similar to the short output, but will remain stable
  41         across Git versions and regardless of user configuration. See
  42         below for details.
  43 +
  44 The version parameter is used to specify the format version.
  45 This is optional and defaults to the original version 'v1' format.
  46
  47 --long::
  48         Give the output in the long-format. This is the default.
  49
  50 -v::
  51 --verbose::
  52         In addition to the names of files that have been changed, also
  53         show the textual changes that are staged to be committed
  54         (i.e., like the output of `git diff --cached`). If `-v` is specified
  55         twice, then also show the changes in the working tree that
  56         have not yet been staged (i.e., like the output of `git diff`).
  57
  58 -u[<mode>]::
  59 --untracked-files[=<mode>]::
  60         Show untracked files.
  61 +
  62 The mode parameter is used to specify the handling of untracked files.
  63 It is optional: it defaults to 'all', and if specified, it must be
  64 stuck to the option (e.g. `-uno`, but not `-u no`).
  65 +
  66 The possible options are:
  67 +
  68         - 'no'     - Show no untracked files.
  69         - 'normal' - Shows untracked files and directories.
  70         - 'all'    - Also shows individual files in untracked directories.
  71 +
  72 When `-u` option is not used, untracked files and directories are
  73 shown (i.e. the same as specifying `normal`), to help you avoid
  74 forgetting to add newly created files.  Because it takes extra work
  75 to find untracked files in the filesystem, this mode may take some
  76 time in a large working tree.
  77 Consider enabling untracked cache and split index if supported (see
  78 `git update-index --untracked-cache` and `git update-index
  79 --split-index`), Otherwise you can use `no` to have `git status`
  80 return more quickly without showing untracked files.
  81 +
  82 The default can be changed using the status.showUntrackedFiles
  83 configuration variable documented in linkgit:git-config[1].
  84
  85 --ignore-submodules[=<when>]::
  86         Ignore changes to submodules when looking for changes. <when> can be
  87         either "none", "untracked", "dirty" or "all", which is the default.
  88         Using "none" will consider the submodule modified when it either contains
  89         untracked or modified files or its HEAD differs from the commit recorded
  90         in the superproject and can be used to override any settings of the
  91         'ignore' option in linkgit:git-config[1] or linkgit:gitmodules[5]. When
  92         "untracked" is used submodules are not considered dirty when they only
  93         contain untracked content (but they are still scanned for modified
  94         content). Using "dirty" ignores all changes to the work tree of submodules,
  95         only changes to the commits stored in the superproject are shown (this was
  96         the behavior before 1.7.0). Using "all" hides all changes to submodules
  97         (and suppresses the output of submodule summaries when the config option
  98         `status.submoduleSummary` is set).
  99
 100 --ignored::
 101         Show ignored files as well.
 102
 103 -z::
 104         Terminate entries with NUL, instead of LF.  This implies
 105         the `--porcelain=v1` output format if no other format is given.
 106
 107 --column[=<options>]::
 108 --no-column::
 109         Display untracked files in columns. See configuration variable
 110         column.status for option syntax.`--column` and `--no-column`
 111         without options are equivalent to 'always' and 'never'
 112         respectively.
 113
 114 <pathspec>...::
 115         See the 'pathspec' entry in linkgit:gitglossary[7].
 116
 117 OUTPUT
 118 ------
 119 The output from this command is designed to be used as a commit
 120 template comment.
 121 The default, long format, is designed to be human readable,
 122 verbose and descriptive.  Its contents and format are subject to change
 123 at any time.
 124
 125 The paths mentioned in the output, unlike many other Git commands, are
 126 made relative to the current directory if you are working in a
 127 subdirectory (this is on purpose, to help cutting and pasting). See
 128 the status.relativePaths config option below.
 129
 130 Short Format
 131 ~~~~~~~~~~~~
 132
 133 In the short-format, the status of each path is shown as
 134
 135         XY PATH1 -> PATH2
 136
 137 where `PATH1` is the path in the `HEAD`, and the " `-> PATH2`" part is
 138 shown only when `PATH1` corresponds to a different path in the
 139 index/worktree (i.e. the file is renamed). The `XY` is a two-letter
 140 status code.
 141
 142 The fields (including the `->`) are separated from each other by a
 143 single space. If a filename contains whitespace or other nonprintable
 144 characters, that field will be quoted in the manner of a C string
 145 literal: surrounded by ASCII double quote (34) characters, and with
 146 interior special characters backslash-escaped.
 147
 148 For paths with merge conflicts, `X` and `Y` show the modification
 149 states of each side of the merge. For paths that do not have merge
 150 conflicts, `X` shows the status of the index, and `Y` shows the status
 151 of the work tree.  For untracked paths, `XY` are `??`.  Other status
 152 codes can be interpreted as follows:
 153
 154 * ' ' = unmodified
 155 * 'M' = modified
 156 * 'A' = added
 157 * 'D' = deleted
 158 * 'R' = renamed
 159 * 'C' = copied
 160 * 'U' = updated but unmerged
 161
 162 Ignored files are not listed, unless `--ignored` option is in effect,
 163 in which case `XY` are `!!`.
 164
 165     X          Y     Meaning
 166     -------------------------------------------------
 167               [MD]   not updated
 168     M        [ MD]   updated in index
 169     A        [ MD]   added to index
 170     D         [ M]   deleted from index
 171     R        [ MD]   renamed in index
 172     C        [ MD]   copied in index
 173     [MARC]           index and work tree matches
 174     [ MARC]     M    work tree changed since index
 175     [ MARC]     D    deleted in work tree
 176     -------------------------------------------------
 177     D           D    unmerged, both deleted
 178     A           U    unmerged, added by us
 179     U           D    unmerged, deleted by them
 180     U           A    unmerged, added by them
 181     D           U    unmerged, deleted by us
 182     A           A    unmerged, both added
 183     U           U    unmerged, both modified
 184     -------------------------------------------------
 185     ?           ?    untracked
 186     !           !    ignored
 187     -------------------------------------------------
 188
 189 Submodules have more state and instead report
 190                 M    the submodule has a different HEAD than
 191                      recorded in the index
 192                 m    the submodule has modified content
 193                 ?    the submodule has untracked files
 194 since modified content or untracked files in a submodule cannot be added
 195 via `git add` in the superproject to prepare a commit.
 196
 197 'm' and '?' are applied recursively. For example if a nested submodule
 198 in a submodule contains an untracked file, this is reported as '?' as well.
 199
 200 If -b is used the short-format status is preceded by a line
 201
 202     ## branchname tracking info
 203
 204 Porcelain Format Version 1
 205 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 206
 207 Version 1 porcelain format is similar to the short format, but is guaranteed
 208 not to change in a backwards-incompatible way between Git versions or
 209 based on user configuration. This makes it ideal for parsing by scripts.
 210 The description of the short format above also describes the porcelain
 211 format, with a few exceptions:
 212
 213 1. The user's color.status configuration is not respected; color will
 214    always be off.
 215
 216 2. The user's status.relativePaths configuration is not respected; paths
 217    shown will always be relative to the repository root.
 218
 219 There is also an alternate -z format recommended for machine parsing. In
 220 that format, the status field is the same, but some other things
 221 change.  First, the '\->' is omitted from rename entries and the field
 222 order is reversed (e.g 'from \-> to' becomes 'to from'). Second, a NUL
 223 (ASCII 0) follows each filename, replacing space as a field separator
 224 and the terminating newline (but a space still separates the status
 225 field from the first filename).  Third, filenames containing special
 226 characters are not specially formatted; no quoting or
 227 backslash-escaping is performed.
 228
 229 Any submodule changes are reported as modified `M` instead of `m` or single `?`.
 230
 231 Porcelain Format Version 2
 232 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 233
 234 Version 2 format adds more detailed information about the state of
 235 the worktree and changed items.  Version 2 also defines an extensible
 236 set of easy to parse optional headers.
 237
 238 Header lines start with "#" and are added in response to specific
 239 command line arguments.  Parsers should ignore headers they
 240 don't recognize.
 241
 242 ### Branch Headers
 243
 244 If `--branch` is given, a series of header lines are printed with
 245 information about the current branch.
 246
 247     Line                                     Notes
 248     ------------------------------------------------------------
 249     # branch.oid <commit> | (initial)        Current commit.
 250     # branch.head <branch> | (detached)      Current branch.
 251     # branch.upstream <upstream_branch>      If upstream is set.
 252     # branch.ab +<ahead> -<behind>           If upstream is set and
 253                                              the commit is present.
 254     ------------------------------------------------------------
 255
 256 ### Changed Tracked Entries
 257
 258 Following the headers, a series of lines are printed for tracked
 259 entries.  One of three different line formats may be used to describe
 260 an entry depending on the type of change.  Tracked entries are printed
 261 in an undefined order; parsers should allow for a mixture of the 3
 262 line types in any order.
 263
 264 Ordinary changed entries have the following format:
 265
 266     1 <XY> <sub> <mH> <mI> <mW> <hH> <hI> <path>
 267
 268 Renamed or copied entries have the following format:
 269
 270     2 <XY> <sub> <mH> <mI> <mW> <hH> <hI> <X><score> <path><sep><origPath>
 271
 272     Field       Meaning
 273     --------------------------------------------------------
 274     <XY>        A 2 character field containing the staged and
 275                 unstaged XY values described in the short format,
 276                 with unchanged indicated by a "." rather than
 277                 a space.
 278     <sub>       A 4 character field describing the submodule state.
 279                 "N..." when the entry is not a submodule.
 280                 "S<c><m><u>" when the entry is a submodule.
 281                 <c> is "C" if the commit changed; otherwise ".".
 282                 <m> is "M" if it has tracked changes; otherwise ".".
 283                 <u> is "U" if there are untracked changes; otherwise ".".
 284     <mH>        The octal file mode in HEAD.
 285     <mI>        The octal file mode in the index.
 286     <mW>        The octal file mode in the worktree.
 287     <hH>        The object name in HEAD.
 288     <hI>        The object name in the index.
 289     <X><score>  The rename or copy score (denoting the percentage
 290                 of similarity between the source and target of the
 291                 move or copy). For example "R100" or "C75".
 292     <path>      The pathname.  In a renamed/copied entry, this
 293                 is the path in the index and in the working tree.
 294     <sep>       When the `-z` option is used, the 2 pathnames are separated
 295                 with a NUL (ASCII 0x00) byte; otherwise, a tab (ASCII 0x09)
 296                 byte separates them.
 297     <origPath>  The pathname in the commit at HEAD.  This is only
 298                 present in a renamed/copied entry, and tells
 299                 where the renamed/copied contents came from.
 300     --------------------------------------------------------
 301
 302 Unmerged entries have the following format; the first character is
 303 a "u" to distinguish from ordinary changed entries.
 304
 305     u <xy> <sub> <m1> <m2> <m3> <mW> <h1> <h2> <h3> <path>
 306
 307     Field       Meaning
 308     --------------------------------------------------------
 309     <XY>        A 2 character field describing the conflict type
 310                 as described in the short format.
 311     <sub>       A 4 character field describing the submodule state
 312                 as described above.
 313     <m1>        The octal file mode in stage 1.
 314     <m2>        The octal file mode in stage 2.
 315     <m3>        The octal file mode in stage 3.
 316     <mW>        The octal file mode in the worktree.
 317     <h1>        The object name in stage 1.
 318     <h2>        The object name in stage 2.
 319     <h3>        The object name in stage 3.
 320     <path>      The pathname.
 321     --------------------------------------------------------
 322
 323 ### Other Items
 324
 325 Following the tracked entries (and if requested), a series of
 326 lines will be printed for untracked and then ignored items
 327 found in the worktree.
 328
 329 Untracked items have the following format:
 330
 331     ? <path>
 332
 333 Ignored items have the following format:
 334
 335     ! <path>
 336
 337 ### Pathname Format Notes and -z
 338
 339 When the `-z` option is given, pathnames are printed as is and
 340 without any quoting and lines are terminated with a NUL (ASCII 0x00)
 341 byte.
 342
 343 Without the `-z` option, pathnames with "unusual" characters are
 344 quoted as explained for the configuration variable `core.quotePath`
 345 (see linkgit:git-config[1]).
 346
 347
 348 CONFIGURATION
 349 -------------
 350
 351 The command honors `color.status` (or `status.color` -- they
 352 mean the same thing and the latter is kept for backward
 353 compatibility) and `color.status.<slot>` configuration variables
 354 to colorize its output.
 355
 356 If the config variable `status.relativePaths` is set to false, then all
 357 paths shown are relative to the repository root, not to the current
 358 directory.
 359
 360 If `status.submoduleSummary` is set to a non zero number or true (identical
 361 to -1 or an unlimited number), the submodule summary will be enabled for
 362 the long format and a summary of commits for modified submodules will be
 363 shown (see --summary-limit option of linkgit:git-submodule[1]). Please note
 364 that the summary output from the status command will be suppressed for all
 365 submodules when `diff.ignoreSubmodules` is set to 'all' or only for those
 366 submodules where `submodule.<name>.ignore=all`. To also view the summary for
 367 ignored submodules you can either use the --ignore-submodules=dirty command
 368 line option or the 'git submodule summary' command, which shows a similar
 369 output but does not honor these settings.
 370
 371 SEE ALSO
 372 --------
 373 linkgit:gitignore[5]
 374
 375 GIT
 376 ---
 377 Part of the linkgit:git[1] suite