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[=<mode>]::
 101         Show ignored files as well.
 102 +
 103 The mode parameter is used to specify the handling of ignored files.
 104 It is optional: it defaults to 'traditional'.
 105 +
 106 The possible options are:
 107 +
 108         - 'traditional' - Shows ignored files and directories, unless
 109                           --untracked-files=all is specifed, in which case
 110                           individual files in ignored directories are
 111                           displayed.
 112         - 'no'          - Show no ignored files.
 113         - 'matching'    - Shows ignored files and directories matching an
 114                           ignore pattern.
 115 +
 116 When 'matching' mode is specified, paths that explicity match an
 117 ignored pattern are shown. If a directory matches an ignore pattern,
 118 then it is shown, but not paths contained in the ignored directory. If
 119 a directory does not match an ignore pattern, but all contents are
 120 ignored, then the directory is not shown, but all contents are shown.
 121
 122 -z::
 123         Terminate entries with NUL, instead of LF.  This implies
 124         the `--porcelain=v1` output format if no other format is given.
 125
 126 --column[=<options>]::
 127 --no-column::
 128         Display untracked files in columns. See configuration variable
 129         column.status for option syntax.`--column` and `--no-column`
 130         without options are equivalent to 'always' and 'never'
 131         respectively.
 132
 133 --ahead-behind::
 134 --no-ahead-behind::
 135         Display or do not display detailed ahead/behind counts for the
 136         branch relative to its upstream branch.  Defaults to true.
 137
 138 <pathspec>...::
 139         See the 'pathspec' entry in linkgit:gitglossary[7].
 140
 141 OUTPUT
 142 ------
 143 The output from this command is designed to be used as a commit
 144 template comment.
 145 The default, long format, is designed to be human readable,
 146 verbose and descriptive.  Its contents and format are subject to change
 147 at any time.
 148
 149 The paths mentioned in the output, unlike many other Git commands, are
 150 made relative to the current directory if you are working in a
 151 subdirectory (this is on purpose, to help cutting and pasting). See
 152 the status.relativePaths config option below.
 153
 154 Short Format
 155 ~~~~~~~~~~~~
 156
 157 In the short-format, the status of each path is shown as one of these
 158 forms
 159
 160         XY PATH
 161         XY ORIG_PATH -> PATH
 162
 163 where `ORIG_PATH` is where the renamed/copied contents came
 164 from. `ORIG_PATH` is only shown when the entry is renamed or
 165 copied. The `XY` is a two-letter status code.
 166
 167 The fields (including the `->`) are separated from each other by a
 168 single space. If a filename contains whitespace or other nonprintable
 169 characters, that field will be quoted in the manner of a C string
 170 literal: surrounded by ASCII double quote (34) characters, and with
 171 interior special characters backslash-escaped.
 172
 173 For paths with merge conflicts, `X` and `Y` show the modification
 174 states of each side of the merge. For paths that do not have merge
 175 conflicts, `X` shows the status of the index, and `Y` shows the status
 176 of the work tree.  For untracked paths, `XY` are `??`.  Other status
 177 codes can be interpreted as follows:
 178
 179 * ' ' = unmodified
 180 * 'M' = modified
 181 * 'A' = added
 182 * 'D' = deleted
 183 * 'R' = renamed
 184 * 'C' = copied
 185 * 'U' = updated but unmerged
 186
 187 Ignored files are not listed, unless `--ignored` option is in effect,
 188 in which case `XY` are `!!`.
 189
 190     X          Y     Meaning
 191     -------------------------------------------------
 192              [AMD]   not updated
 193     M        [ MD]   updated in index
 194     A        [ MD]   added to index
 195     D                deleted from index
 196     R        [ MD]   renamed in index
 197     C        [ MD]   copied in index
 198     [MARC]           index and work tree matches
 199     [ MARC]     M    work tree changed since index
 200     [ MARC]     D    deleted in work tree
 201     [ D]        R    renamed in work tree
 202     [ D]        C    copied in work tree
 203     -------------------------------------------------
 204     D           D    unmerged, both deleted
 205     A           U    unmerged, added by us
 206     U           D    unmerged, deleted by them
 207     U           A    unmerged, added by them
 208     D           U    unmerged, deleted by us
 209     A           A    unmerged, both added
 210     U           U    unmerged, both modified
 211     -------------------------------------------------
 212     ?           ?    untracked
 213     !           !    ignored
 214     -------------------------------------------------
 215
 216 Submodules have more state and instead report
 217                 M    the submodule has a different HEAD than
 218                      recorded in the index
 219                 m    the submodule has modified content
 220                 ?    the submodule has untracked files
 221 since modified content or untracked files in a submodule cannot be added
 222 via `git add` in the superproject to prepare a commit.
 223
 224 'm' and '?' are applied recursively. For example if a nested submodule
 225 in a submodule contains an untracked file, this is reported as '?' as well.
 226
 227 If -b is used the short-format status is preceded by a line
 228
 229     ## branchname tracking info
 230
 231 Porcelain Format Version 1
 232 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 233
 234 Version 1 porcelain format is similar to the short format, but is guaranteed
 235 not to change in a backwards-incompatible way between Git versions or
 236 based on user configuration. This makes it ideal for parsing by scripts.
 237 The description of the short format above also describes the porcelain
 238 format, with a few exceptions:
 239
 240 1. The user's color.status configuration is not respected; color will
 241    always be off.
 242
 243 2. The user's status.relativePaths configuration is not respected; paths
 244    shown will always be relative to the repository root.
 245
 246 There is also an alternate -z format recommended for machine parsing. In
 247 that format, the status field is the same, but some other things
 248 change.  First, the '\->' is omitted from rename entries and the field
 249 order is reversed (e.g 'from \-> to' becomes 'to from'). Second, a NUL
 250 (ASCII 0) follows each filename, replacing space as a field separator
 251 and the terminating newline (but a space still separates the status
 252 field from the first filename).  Third, filenames containing special
 253 characters are not specially formatted; no quoting or
 254 backslash-escaping is performed.
 255
 256 Any submodule changes are reported as modified `M` instead of `m` or single `?`.
 257
 258 Porcelain Format Version 2
 259 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 260
 261 Version 2 format adds more detailed information about the state of
 262 the worktree and changed items.  Version 2 also defines an extensible
 263 set of easy to parse optional headers.
 264
 265 Header lines start with "#" and are added in response to specific
 266 command line arguments.  Parsers should ignore headers they
 267 don't recognize.
 268
 269 ### Branch Headers
 270
 271 If `--branch` is given, a series of header lines are printed with
 272 information about the current branch.
 273
 274     Line                                     Notes
 275     ------------------------------------------------------------
 276     # branch.oid <commit> | (initial)        Current commit.
 277     # branch.head <branch> | (detached)      Current branch.
 278     # branch.upstream <upstream_branch>      If upstream is set.
 279     # branch.ab +<ahead> -<behind>           If upstream is set and
 280                                              the commit is present.
 281     ------------------------------------------------------------
 282
 283 ### Changed Tracked Entries
 284
 285 Following the headers, a series of lines are printed for tracked
 286 entries.  One of three different line formats may be used to describe
 287 an entry depending on the type of change.  Tracked entries are printed
 288 in an undefined order; parsers should allow for a mixture of the 3
 289 line types in any order.
 290
 291 Ordinary changed entries have the following format:
 292
 293     1 <XY> <sub> <mH> <mI> <mW> <hH> <hI> <path>
 294
 295 Renamed or copied entries have the following format:
 296
 297     2 <XY> <sub> <mH> <mI> <mW> <hH> <hI> <X><score> <path><sep><origPath>
 298
 299     Field       Meaning
 300     --------------------------------------------------------
 301     <XY>        A 2 character field containing the staged and
 302                 unstaged XY values described in the short format,
 303                 with unchanged indicated by a "." rather than
 304                 a space.
 305     <sub>       A 4 character field describing the submodule state.
 306                 "N..." when the entry is not a submodule.
 307                 "S<c><m><u>" when the entry is a submodule.
 308                 <c> is "C" if the commit changed; otherwise ".".
 309                 <m> is "M" if it has tracked changes; otherwise ".".
 310                 <u> is "U" if there are untracked changes; otherwise ".".
 311     <mH>        The octal file mode in HEAD.
 312     <mI>        The octal file mode in the index.
 313     <mW>        The octal file mode in the worktree.
 314     <hH>        The object name in HEAD.
 315     <hI>        The object name in the index.
 316     <X><score>  The rename or copy score (denoting the percentage
 317                 of similarity between the source and target of the
 318                 move or copy). For example "R100" or "C75".
 319     <path>      The pathname.  In a renamed/copied entry, this
 320                 is the target path.
 321     <sep>       When the `-z` option is used, the 2 pathnames are separated
 322                 with a NUL (ASCII 0x00) byte; otherwise, a tab (ASCII 0x09)
 323                 byte separates them.
 324     <origPath>  The pathname in the commit at HEAD or in the index.
 325                 This is only present in a renamed/copied entry, and
 326                 tells where the renamed/copied contents came from.
 327     --------------------------------------------------------
 328
 329 Unmerged entries have the following format; the first character is
 330 a "u" to distinguish from ordinary changed entries.
 331
 332     u <xy> <sub> <m1> <m2> <m3> <mW> <h1> <h2> <h3> <path>
 333
 334     Field       Meaning
 335     --------------------------------------------------------
 336     <XY>        A 2 character field describing the conflict type
 337                 as described in the short format.
 338     <sub>       A 4 character field describing the submodule state
 339                 as described above.
 340     <m1>        The octal file mode in stage 1.
 341     <m2>        The octal file mode in stage 2.
 342     <m3>        The octal file mode in stage 3.
 343     <mW>        The octal file mode in the worktree.
 344     <h1>        The object name in stage 1.
 345     <h2>        The object name in stage 2.
 346     <h3>        The object name in stage 3.
 347     <path>      The pathname.
 348     --------------------------------------------------------
 349
 350 ### Other Items
 351
 352 Following the tracked entries (and if requested), a series of
 353 lines will be printed for untracked and then ignored items
 354 found in the worktree.
 355
 356 Untracked items have the following format:
 357
 358     ? <path>
 359
 360 Ignored items have the following format:
 361
 362     ! <path>
 363
 364 ### Pathname Format Notes and -z
 365
 366 When the `-z` option is given, pathnames are printed as is and
 367 without any quoting and lines are terminated with a NUL (ASCII 0x00)
 368 byte.
 369
 370 Without the `-z` option, pathnames with "unusual" characters are
 371 quoted as explained for the configuration variable `core.quotePath`
 372 (see linkgit:git-config[1]).
 373
 374
 375 CONFIGURATION
 376 -------------
 377
 378 The command honors `color.status` (or `status.color` -- they
 379 mean the same thing and the latter is kept for backward
 380 compatibility) and `color.status.<slot>` configuration variables
 381 to colorize its output.
 382
 383 If the config variable `status.relativePaths` is set to false, then all
 384 paths shown are relative to the repository root, not to the current
 385 directory.
 386
 387 If `status.submoduleSummary` is set to a non zero number or true (identical
 388 to -1 or an unlimited number), the submodule summary will be enabled for
 389 the long format and a summary of commits for modified submodules will be
 390 shown (see --summary-limit option of linkgit:git-submodule[1]). Please note
 391 that the summary output from the status command will be suppressed for all
 392 submodules when `diff.ignoreSubmodules` is set to 'all' or only for those
 393 submodules where `submodule.<name>.ignore=all`. To also view the summary for
 394 ignored submodules you can either use the --ignore-submodules=dirty command
 395 line option or the 'git submodule summary' command, which shows a similar
 396 output but does not honor these settings.
 397
 398 BACKGROUND REFRESH
 399 ------------------
 400
 401 By default, `git status` will automatically refresh the index, updating
 402 the cached stat information from the working tree and writing out the
 403 result. Writing out the updated index is an optimization that isn't
 404 strictly necessary (`status` computes the values for itself, but writing
 405 them out is just to save subsequent programs from repeating our
 406 computation). When `status` is run in the background, the lock held
 407 during the write may conflict with other simultaneous processes, causing
 408 them to fail. Scripts running `status` in the background should consider
 409 using `git --no-optional-locks status` (see linkgit:git[1] for details).
 410
 411 SEE ALSO
 412 --------
 413 linkgit:gitignore[5]
 414
 415 GIT
 416 ---
 417 Part of the linkgit:git[1] suite