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