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