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