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