]>
Commit | Line | Data |
---|---|---|
215a7ad1 JH |
1 | git-status(1) |
2 | ============= | |
3f971fc4 JH |
3 | |
4 | NAME | |
5 | ---- | |
c3f0baac | 6 | git-status - Show the working tree status |
3f971fc4 JH |
7 | |
8 | ||
9 | SYNOPSIS | |
10 | -------- | |
7791a1d9 | 11 | [verse] |
9e4b7ab6 | 12 | 'git status' [<options>...] [--] [<pathspec>...] |
3f971fc4 JH |
13 | |
14 | DESCRIPTION | |
15 | ----------- | |
2099bca9 JK |
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 | |
2de9b711 | 19 | tracked by Git (and are not ignored by linkgit:gitignore[5]). The first |
2099bca9 | 20 | are what you _would_ commit by running `git commit`; the second and |
0b444cdb | 21 | third are what you _could_ commit by running 'git add' before running |
2099bca9 | 22 | `git commit`. |
3f971fc4 | 23 | |
9e4b7ab6 JH |
24 | OPTIONS |
25 | ------- | |
26 | ||
27 | -s:: | |
28 | --short:: | |
29 | Give the output in the short-format. | |
30 | ||
46077fa5 MG |
31 | -b:: |
32 | --branch:: | |
33 | Show the branch and tracking info even in short-format. | |
34 | ||
c1b5d019 LB |
35 | --show-stash:: |
36 | Show the number of entries currently stashed away. | |
37 | ||
c4f596b9 | 38 | --porcelain[=<version>]:: |
fc17df03 JK |
39 | Give the output in an easy-to-parse format for scripts. |
40 | This is similar to the short output, but will remain stable | |
2de9b711 | 41 | across Git versions and regardless of user configuration. See |
fc17df03 | 42 | below for details. |
c4f596b9 JH |
43 | + |
44 | The version parameter is used to specify the format version. | |
45 | This is optional and defaults to the original version 'v1' format. | |
6f157871 | 46 | |
f3f47a1e JK |
47 | --long:: |
48 | Give the output in the long-format. This is the default. | |
49 | ||
9c589d97 MH |
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 | ||
9e4b7ab6 JH |
58 | -u[<mode>]:: |
59 | --untracked-files[=<mode>]:: | |
4cc62606 | 60 | Show untracked files. |
9e4b7ab6 | 61 | + |
2b594bf9 MM |
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`). | |
4cc62606 CB |
65 | + |
66 | The possible options are: | |
9e4b7ab6 | 67 | + |
5823eb2b JH |
68 | - 'no' - Show no untracked files. |
69 | - 'normal' - Shows untracked files and directories. | |
9e4b7ab6 | 70 | - 'all' - Also shows individual files in untracked directories. |
9e4b7ab6 | 71 | + |
5823eb2b JH |
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 | |
aeb6f8b3 NTND |
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` | |
5823eb2b JH |
80 | return more quickly without showing untracked files. |
81 | + | |
4cc62606 CB |
82 | The default can be changed using the status.showUntrackedFiles |
83 | configuration variable documented in linkgit:git-config[1]. | |
9e4b7ab6 | 84 | |
46a958b3 JL |
85 | --ignore-submodules[=<when>]:: |
86 | Ignore changes to submodules when looking for changes. <when> can be | |
aee9c7d6 JL |
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 | |
302ad7a9 | 91 | 'ignore' option in linkgit:git-config[1] or linkgit:gitmodules[5]. When |
46a958b3 JL |
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 | |
da0005b8 | 98 | `status.submoduleSummary` is set). |
46a958b3 | 99 | |
1b2bc391 | 100 | --ignored[=<mode>]:: |
150b493a | 101 | Show ignored files as well. |
1b2bc391 JM |
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 | |
928f0ab4 | 109 | --untracked-files=all is specified, in which case |
1b2bc391 JM |
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 | + | |
c30d4f1b | 116 | When 'matching' mode is specified, paths that explicitly match an |
1b2bc391 JM |
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. | |
150b493a | 121 | |
9e4b7ab6 | 122 | -z:: |
6f157871 | 123 | Terminate entries with NUL, instead of LF. This implies |
c4f596b9 | 124 | the `--porcelain=v1` output format if no other format is given. |
2099bca9 | 125 | |
323d0530 NTND |
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 | ||
fd9b544a JH |
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 | ||
e8b2dc2c BP |
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 | ||
93dbefb3 MR |
148 | <pathspec>...:: |
149 | See the 'pathspec' entry in linkgit:gitglossary[7]. | |
3f971fc4 JH |
150 | |
151 | OUTPUT | |
152 | ------ | |
153 | The output from this command is designed to be used as a commit | |
22d55aee | 154 | template comment. |
9e4b7ab6 | 155 | The default, long format, is designed to be human readable, |
043b5cd9 JK |
156 | verbose and descriptive. Its contents and format are subject to change |
157 | at any time. | |
3f971fc4 | 158 | |
2de9b711 | 159 | The paths mentioned in the output, unlike many other Git commands, are |
2099bca9 | 160 | made relative to the current directory if you are working in a |
46f721c8 JK |
161 | subdirectory (this is on purpose, to help cutting and pasting). See |
162 | the status.relativePaths config option below. | |
c7860507 | 163 | |
fc17df03 JK |
164 | Short Format |
165 | ~~~~~~~~~~~~ | |
166 | ||
176ea747 NTND |
167 | In the short-format, the status of each path is shown as one of these |
168 | forms | |
9e4b7ab6 | 169 | |
176ea747 NTND |
170 | XY PATH |
171 | XY ORIG_PATH -> PATH | |
9e4b7ab6 | 172 | |
176ea747 NTND |
173 | where `ORIG_PATH` is where the renamed/copied contents came |
174 | from. `ORIG_PATH` is only shown when the entry is renamed or | |
175 | copied. The `XY` is a two-letter status code. | |
e92e9cd3 | 176 | |
6cf378f0 | 177 | The fields (including the `->`) are separated from each other by a |
e92e9cd3 ER |
178 | single space. If a filename contains whitespace or other nonprintable |
179 | characters, that field will be quoted in the manner of a C string | |
180 | literal: surrounded by ASCII double quote (34) characters, and with | |
181 | interior special characters backslash-escaped. | |
182 | ||
7c45cee6 | 183 | For paths with merge conflicts, `X` and `Y` show the modification |
e92e9cd3 ER |
184 | states of each side of the merge. For paths that do not have merge |
185 | conflicts, `X` shows the status of the index, and `Y` shows the status | |
186 | of the work tree. For untracked paths, `XY` are `??`. Other status | |
187 | codes 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 | ||
50cebdad JH |
197 | Ignored files are not listed, unless `--ignored` option is in effect, |
198 | in which case `XY` are `!!`. | |
9e4b7ab6 | 199 | |
b62eb1d2 MÅ |
200 | .... |
201 | X Y Meaning | |
202 | ------------------------------------------------- | |
203 | [AMD] not updated | |
204 | M [ MD] updated in index | |
205 | A [ MD] added to index | |
206 | D deleted from index | |
207 | R [ MD] renamed in index | |
208 | C [ 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 | ------------------------------------------------- | |
215 | D D unmerged, both deleted | |
216 | A U unmerged, added by us | |
217 | U D unmerged, deleted by them | |
218 | U A unmerged, added by them | |
219 | D U unmerged, deleted by us | |
220 | A A unmerged, both added | |
221 | U U unmerged, both modified | |
222 | ------------------------------------------------- | |
223 | ? ? untracked | |
224 | ! ! ignored | |
225 | ------------------------------------------------- | |
226 | .... | |
9e4b7ab6 | 227 | |
dd6962dd SB |
228 | Submodules 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 | |
233 | since modified content or untracked files in a submodule cannot be added | |
234 | via `git add` in the superproject to prepare a commit. | |
235 | ||
40069d6e SB |
236 | 'm' and '?' are applied recursively. For example if a nested submodule |
237 | in a submodule contains an untracked file, this is reported as '?' as well. | |
dd6962dd | 238 | |
46077fa5 MG |
239 | If -b is used the short-format status is preceded by a line |
240 | ||
1cd828dd | 241 | ## branchname tracking info |
46077fa5 | 242 | |
1cd828dd JH |
243 | Porcelain Format Version 1 |
244 | ~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
fc17df03 | 245 | |
1cd828dd | 246 | Version 1 porcelain format is similar to the short format, but is guaranteed |
2de9b711 | 247 | not to change in a backwards-incompatible way between Git versions or |
fc17df03 JK |
248 | based on user configuration. This makes it ideal for parsing by scripts. |
249 | The description of the short format above also describes the porcelain | |
250 | format, with a few exceptions: | |
251 | ||
252 | 1. The user's color.status configuration is not respected; color will | |
253 | always be off. | |
254 | ||
255 | 2. The user's status.relativePaths configuration is not respected; paths | |
256 | shown will always be relative to the repository root. | |
257 | ||
258 | There is also an alternate -z format recommended for machine parsing. In | |
e92e9cd3 | 259 | that format, the status field is the same, but some other things |
715e716a JK |
260 | change. First, the '\->' is omitted from rename entries and the field |
261 | order is reversed (e.g 'from \-> to' becomes 'to from'). Second, a NUL | |
e92e9cd3 ER |
262 | (ASCII 0) follows each filename, replacing space as a field separator |
263 | and the terminating newline (but a space still separates the status | |
264 | field from the first filename). Third, filenames containing special | |
265 | characters are not specially formatted; no quoting or | |
d4a6bf1f | 266 | backslash-escaping is performed. |
3f971fc4 | 267 | |
dd6962dd SB |
268 | Any submodule changes are reported as modified `M` instead of `m` or single `?`. |
269 | ||
1cd828dd JH |
270 | Porcelain Format Version 2 |
271 | ~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
272 | ||
273 | Version 2 format adds more detailed information about the state of | |
274 | the worktree and changed items. Version 2 also defines an extensible | |
275 | set of easy to parse optional headers. | |
276 | ||
277 | Header lines start with "#" and are added in response to specific | |
278 | command line arguments. Parsers should ignore headers they | |
279 | don't recognize. | |
280 | ||
473dd357 TZ |
281 | Branch Headers |
282 | ^^^^^^^^^^^^^^ | |
1cd828dd JH |
283 | |
284 | If `--branch` is given, a series of header lines are printed with | |
285 | information about the current branch. | |
286 | ||
b62eb1d2 MÅ |
287 | .... |
288 | Line 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 | .... | |
1cd828dd | 297 | |
473dd357 TZ |
298 | Changed Tracked Entries |
299 | ^^^^^^^^^^^^^^^^^^^^^^^ | |
1cd828dd JH |
300 | |
301 | Following the headers, a series of lines are printed for tracked | |
302 | entries. One of three different line formats may be used to describe | |
303 | an entry depending on the type of change. Tracked entries are printed | |
304 | in an undefined order; parsers should allow for a mixture of the 3 | |
305 | line types in any order. | |
306 | ||
307 | Ordinary changed entries have the following format: | |
308 | ||
309 | 1 <XY> <sub> <mH> <mI> <mW> <hH> <hI> <path> | |
310 | ||
311 | Renamed or copied entries have the following format: | |
312 | ||
313 | 2 <XY> <sub> <mH> <mI> <mW> <hH> <hI> <X><score> <path><sep><origPath> | |
314 | ||
b62eb1d2 MÅ |
315 | .... |
316 | Field 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 | .... | |
1cd828dd JH |
346 | |
347 | Unmerged entries have the following format; the first character is | |
348 | a "u" to distinguish from ordinary changed entries. | |
349 | ||
350 | u <xy> <sub> <m1> <m2> <m3> <mW> <h1> <h2> <h3> <path> | |
351 | ||
b62eb1d2 MÅ |
352 | .... |
353 | Field 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 | .... | |
1cd828dd | 369 | |
473dd357 TZ |
370 | Other Items |
371 | ^^^^^^^^^^^ | |
1cd828dd JH |
372 | |
373 | Following the tracked entries (and if requested), a series of | |
374 | lines will be printed for untracked and then ignored items | |
375 | found in the worktree. | |
376 | ||
377 | Untracked items have the following format: | |
378 | ||
379 | ? <path> | |
380 | ||
381 | Ignored items have the following format: | |
382 | ||
383 | ! <path> | |
384 | ||
473dd357 TZ |
385 | Pathname Format Notes and -z |
386 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
1cd828dd JH |
387 | |
388 | When the `-z` option is given, pathnames are printed as is and | |
389 | without any quoting and lines are terminated with a NUL (ASCII 0x00) | |
390 | byte. | |
391 | ||
860cd699 AH |
392 | Without the `-z` option, pathnames with "unusual" characters are |
393 | quoted as explained for the configuration variable `core.quotePath` | |
394 | (see linkgit:git-config[1]). | |
1cd828dd JH |
395 | |
396 | ||
31fcd63c JH |
397 | CONFIGURATION |
398 | ------------- | |
399 | ||
400 | The command honors `color.status` (or `status.color` -- they | |
401 | mean the same thing and the latter is kept for backward | |
402 | compatibility) and `color.status.<slot>` configuration variables | |
403 | to colorize its output. | |
404 | ||
46f721c8 | 405 | If the config variable `status.relativePaths` is set to false, then all |
482a6c10 MG |
406 | paths shown are relative to the repository root, not to the current |
407 | directory. | |
46f721c8 | 408 | |
da0005b8 | 409 | If `status.submoduleSummary` is set to a non zero number or true (identical |
46b77a6b JK |
410 | to -1 or an unlimited number), the submodule summary will be enabled for |
411 | the long format and a summary of commits for modified submodules will be | |
bb58b696 JL |
412 | shown (see --summary-limit option of linkgit:git-submodule[1]). Please note |
413 | that the summary output from the status command will be suppressed for all | |
414 | submodules when `diff.ignoreSubmodules` is set to 'all' or only for those | |
415 | submodules where `submodule.<name>.ignore=all`. To also view the summary for | |
416 | ignored submodules you can either use the --ignore-submodules=dirty command | |
417 | line option or the 'git submodule summary' command, which shows a similar | |
418 | output but does not honor these settings. | |
ac8d5afc | 419 | |
5e83cca0 JK |
420 | BACKGROUND REFRESH |
421 | ------------------ | |
422 | ||
423 | By default, `git status` will automatically refresh the index, updating | |
424 | the cached stat information from the working tree and writing out the | |
425 | result. Writing out the updated index is an optimization that isn't | |
426 | strictly necessary (`status` computes the values for itself, but writing | |
427 | them out is just to save subsequent programs from repeating our | |
428 | computation). When `status` is run in the background, the lock held | |
429 | during the write may conflict with other simultaneous processes, causing | |
430 | them to fail. Scripts running `status` in the background should consider | |
431 | using `git --no-optional-locks status` (see linkgit:git[1] for details). | |
432 | ||
56ae8df5 | 433 | SEE ALSO |
cedb8d5d | 434 | -------- |
5162e697 | 435 | linkgit:gitignore[5] |
31fcd63c | 436 | |
3f971fc4 JH |
437 | GIT |
438 | --- | |
9e1f0a85 | 439 | Part of the linkgit:git[1] suite |