]>
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 | + |
2017956a | 62 | -- |
2b594bf9 MM |
63 | The mode parameter is used to specify the handling of untracked files. |
64 | It is optional: it defaults to 'all', and if specified, it must be | |
65 | stuck to the option (e.g. `-uno`, but not `-u no`). | |
2017956a | 66 | |
4cc62606 | 67 | The possible options are: |
2017956a | 68 | |
5823eb2b JH |
69 | - 'no' - Show no untracked files. |
70 | - 'normal' - Shows untracked files and directories. | |
9e4b7ab6 | 71 | - 'all' - Also shows individual files in untracked directories. |
2017956a | 72 | |
5823eb2b JH |
73 | When `-u` option is not used, untracked files and directories are |
74 | shown (i.e. the same as specifying `normal`), to help you avoid | |
75 | forgetting to add newly created files. Because it takes extra work | |
76 | to find untracked files in the filesystem, this mode may take some | |
aeb6f8b3 NTND |
77 | time in a large working tree. |
78 | Consider enabling untracked cache and split index if supported (see | |
79 | `git update-index --untracked-cache` and `git update-index | |
80 | --split-index`), Otherwise you can use `no` to have `git status` | |
5823eb2b | 81 | return more quickly without showing untracked files. |
2017956a | 82 | |
4cc62606 CB |
83 | The default can be changed using the status.showUntrackedFiles |
84 | configuration variable documented in linkgit:git-config[1]. | |
2017956a | 85 | -- |
9e4b7ab6 | 86 | |
46a958b3 JL |
87 | --ignore-submodules[=<when>]:: |
88 | Ignore changes to submodules when looking for changes. <when> can be | |
aee9c7d6 JL |
89 | either "none", "untracked", "dirty" or "all", which is the default. |
90 | Using "none" will consider the submodule modified when it either contains | |
91 | untracked or modified files or its HEAD differs from the commit recorded | |
92 | in the superproject and can be used to override any settings of the | |
302ad7a9 | 93 | 'ignore' option in linkgit:git-config[1] or linkgit:gitmodules[5]. When |
46a958b3 JL |
94 | "untracked" is used submodules are not considered dirty when they only |
95 | contain untracked content (but they are still scanned for modified | |
96 | content). Using "dirty" ignores all changes to the work tree of submodules, | |
97 | only changes to the commits stored in the superproject are shown (this was | |
98 | the behavior before 1.7.0). Using "all" hides all changes to submodules | |
99 | (and suppresses the output of submodule summaries when the config option | |
da0005b8 | 100 | `status.submoduleSummary` is set). |
46a958b3 | 101 | |
1b2bc391 | 102 | --ignored[=<mode>]:: |
150b493a | 103 | Show ignored files as well. |
1b2bc391 | 104 | + |
2017956a | 105 | -- |
1b2bc391 JM |
106 | The mode parameter is used to specify the handling of ignored files. |
107 | It is optional: it defaults to 'traditional'. | |
2017956a | 108 | |
1b2bc391 | 109 | The possible options are: |
2017956a | 110 | |
1b2bc391 | 111 | - 'traditional' - Shows ignored files and directories, unless |
928f0ab4 | 112 | --untracked-files=all is specified, in which case |
1b2bc391 JM |
113 | individual files in ignored directories are |
114 | displayed. | |
115 | - 'no' - Show no ignored files. | |
116 | - 'matching' - Shows ignored files and directories matching an | |
117 | ignore pattern. | |
2017956a | 118 | |
c30d4f1b | 119 | When 'matching' mode is specified, paths that explicitly match an |
1b2bc391 JM |
120 | ignored pattern are shown. If a directory matches an ignore pattern, |
121 | then it is shown, but not paths contained in the ignored directory. If | |
122 | a directory does not match an ignore pattern, but all contents are | |
123 | ignored, then the directory is not shown, but all contents are shown. | |
2017956a | 124 | -- |
150b493a | 125 | |
9e4b7ab6 | 126 | -z:: |
6f157871 | 127 | Terminate entries with NUL, instead of LF. This implies |
c4f596b9 | 128 | the `--porcelain=v1` output format if no other format is given. |
2099bca9 | 129 | |
323d0530 NTND |
130 | --column[=<options>]:: |
131 | --no-column:: | |
132 | Display untracked files in columns. See configuration variable | |
1b5b8cf0 | 133 | `column.status` for option syntax. `--column` and `--no-column` |
323d0530 NTND |
134 | without options are equivalent to 'always' and 'never' |
135 | respectively. | |
136 | ||
fd9b544a JH |
137 | --ahead-behind:: |
138 | --no-ahead-behind:: | |
139 | Display or do not display detailed ahead/behind counts for the | |
140 | branch relative to its upstream branch. Defaults to true. | |
141 | ||
e8b2dc2c BP |
142 | --renames:: |
143 | --no-renames:: | |
144 | Turn on/off rename detection regardless of user configuration. | |
145 | See also linkgit:git-diff[1] `--no-renames`. | |
146 | ||
147 | --find-renames[=<n>]:: | |
148 | Turn on rename detection, optionally setting the similarity | |
149 | threshold. | |
150 | See also linkgit:git-diff[1] `--find-renames`. | |
151 | ||
93dbefb3 MR |
152 | <pathspec>...:: |
153 | See the 'pathspec' entry in linkgit:gitglossary[7]. | |
3f971fc4 JH |
154 | |
155 | OUTPUT | |
156 | ------ | |
157 | The output from this command is designed to be used as a commit | |
22d55aee | 158 | template comment. |
9e4b7ab6 | 159 | The default, long format, is designed to be human readable, |
043b5cd9 JK |
160 | verbose and descriptive. Its contents and format are subject to change |
161 | at any time. | |
3f971fc4 | 162 | |
2de9b711 | 163 | The paths mentioned in the output, unlike many other Git commands, are |
2099bca9 | 164 | made relative to the current directory if you are working in a |
46f721c8 JK |
165 | subdirectory (this is on purpose, to help cutting and pasting). See |
166 | the status.relativePaths config option below. | |
c7860507 | 167 | |
fc17df03 JK |
168 | Short Format |
169 | ~~~~~~~~~~~~ | |
170 | ||
176ea747 NTND |
171 | In the short-format, the status of each path is shown as one of these |
172 | forms | |
9e4b7ab6 | 173 | |
176ea747 NTND |
174 | XY PATH |
175 | XY ORIG_PATH -> PATH | |
9e4b7ab6 | 176 | |
176ea747 NTND |
177 | where `ORIG_PATH` is where the renamed/copied contents came |
178 | from. `ORIG_PATH` is only shown when the entry is renamed or | |
179 | copied. The `XY` is a two-letter status code. | |
e92e9cd3 | 180 | |
6cf378f0 | 181 | The fields (including the `->`) are separated from each other by a |
e92e9cd3 ER |
182 | single space. If a filename contains whitespace or other nonprintable |
183 | characters, that field will be quoted in the manner of a C string | |
184 | literal: surrounded by ASCII double quote (34) characters, and with | |
185 | interior special characters backslash-escaped. | |
186 | ||
4eb56b56 | 187 | There are three different types of states that are shown using this format, and |
188 | each one uses the `XY` syntax differently: | |
189 | ||
190 | * When a merge is occurring and the merge was successful, or outside of a merge | |
191 | situation, `X` shows the status of the index and `Y` shows the status of the | |
192 | working tree. | |
193 | * When a merge conflict has occurred and has not yet been resolved, `X` and `Y` | |
194 | show the state introduced by each head of the merge, relative to the common | |
195 | ancestor. These paths are said to be _unmerged_. | |
196 | * When a path is untracked, `X` and `Y` are always the same, since they are | |
197 | unknown to the index. `??` is used for untracked paths. Ignored files are | |
198 | not listed unless `--ignored` is used; if it is, ignored files are indicated | |
199 | by `!!`. | |
200 | ||
201 | Note that the term _merge_ here also includes rebases using the default | |
202 | `--merge` strategy, cherry-picks, and anything else using the merge machinery. | |
203 | ||
204 | In the following table, these three classes are shown in separate sections, and | |
205 | these characters are used for `X` and `Y` fields for the first two sections that | |
206 | show tracked paths: | |
e92e9cd3 ER |
207 | |
208 | * ' ' = unmodified | |
209 | * 'M' = modified | |
210 | * 'A' = added | |
211 | * 'D' = deleted | |
212 | * 'R' = renamed | |
213 | * 'C' = copied | |
214 | * 'U' = updated but unmerged | |
215 | ||
b62eb1d2 MÅ |
216 | .... |
217 | X Y Meaning | |
218 | ------------------------------------------------- | |
219 | [AMD] not updated | |
220 | M [ MD] updated in index | |
221 | A [ MD] added to index | |
222 | D deleted from index | |
223 | R [ MD] renamed in index | |
224 | C [ MD] copied in index | |
225 | [MARC] index and work tree matches | |
226 | [ MARC] M work tree changed since index | |
227 | [ MARC] D deleted in work tree | |
228 | [ D] R renamed in work tree | |
229 | [ D] C copied in work tree | |
230 | ------------------------------------------------- | |
231 | D D unmerged, both deleted | |
232 | A U unmerged, added by us | |
233 | U D unmerged, deleted by them | |
234 | U A unmerged, added by them | |
235 | D U unmerged, deleted by us | |
236 | A A unmerged, both added | |
237 | U U unmerged, both modified | |
238 | ------------------------------------------------- | |
239 | ? ? untracked | |
240 | ! ! ignored | |
241 | ------------------------------------------------- | |
242 | .... | |
9e4b7ab6 | 243 | |
dd6962dd SB |
244 | Submodules have more state and instead report |
245 | M the submodule has a different HEAD than | |
246 | recorded in the index | |
247 | m the submodule has modified content | |
248 | ? the submodule has untracked files | |
249 | since modified content or untracked files in a submodule cannot be added | |
250 | via `git add` in the superproject to prepare a commit. | |
251 | ||
40069d6e SB |
252 | 'm' and '?' are applied recursively. For example if a nested submodule |
253 | in a submodule contains an untracked file, this is reported as '?' as well. | |
dd6962dd | 254 | |
46077fa5 MG |
255 | If -b is used the short-format status is preceded by a line |
256 | ||
1cd828dd | 257 | ## branchname tracking info |
46077fa5 | 258 | |
1cd828dd JH |
259 | Porcelain Format Version 1 |
260 | ~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
fc17df03 | 261 | |
1cd828dd | 262 | Version 1 porcelain format is similar to the short format, but is guaranteed |
2de9b711 | 263 | not to change in a backwards-incompatible way between Git versions or |
fc17df03 JK |
264 | based on user configuration. This makes it ideal for parsing by scripts. |
265 | The description of the short format above also describes the porcelain | |
266 | format, with a few exceptions: | |
267 | ||
268 | 1. The user's color.status configuration is not respected; color will | |
269 | always be off. | |
270 | ||
271 | 2. The user's status.relativePaths configuration is not respected; paths | |
272 | shown will always be relative to the repository root. | |
273 | ||
274 | There is also an alternate -z format recommended for machine parsing. In | |
e92e9cd3 | 275 | that format, the status field is the same, but some other things |
715e716a JK |
276 | change. First, the '\->' is omitted from rename entries and the field |
277 | order is reversed (e.g 'from \-> to' becomes 'to from'). Second, a NUL | |
e92e9cd3 ER |
278 | (ASCII 0) follows each filename, replacing space as a field separator |
279 | and the terminating newline (but a space still separates the status | |
280 | field from the first filename). Third, filenames containing special | |
281 | characters are not specially formatted; no quoting or | |
d4a6bf1f | 282 | backslash-escaping is performed. |
3f971fc4 | 283 | |
dd6962dd SB |
284 | Any submodule changes are reported as modified `M` instead of `m` or single `?`. |
285 | ||
1cd828dd JH |
286 | Porcelain Format Version 2 |
287 | ~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
288 | ||
289 | Version 2 format adds more detailed information about the state of | |
290 | the worktree and changed items. Version 2 also defines an extensible | |
291 | set of easy to parse optional headers. | |
292 | ||
293 | Header lines start with "#" and are added in response to specific | |
294 | command line arguments. Parsers should ignore headers they | |
295 | don't recognize. | |
296 | ||
473dd357 TZ |
297 | Branch Headers |
298 | ^^^^^^^^^^^^^^ | |
1cd828dd JH |
299 | |
300 | If `--branch` is given, a series of header lines are printed with | |
301 | information about the current branch. | |
302 | ||
b62eb1d2 MÅ |
303 | .... |
304 | Line Notes | |
305 | ------------------------------------------------------------ | |
306 | # branch.oid <commit> | (initial) Current commit. | |
307 | # branch.head <branch> | (detached) Current branch. | |
308 | # branch.upstream <upstream_branch> If upstream is set. | |
309 | # branch.ab +<ahead> -<behind> If upstream is set and | |
310 | the commit is present. | |
311 | ------------------------------------------------------------ | |
312 | .... | |
1cd828dd | 313 | |
473dd357 TZ |
314 | Changed Tracked Entries |
315 | ^^^^^^^^^^^^^^^^^^^^^^^ | |
1cd828dd JH |
316 | |
317 | Following the headers, a series of lines are printed for tracked | |
318 | entries. One of three different line formats may be used to describe | |
319 | an entry depending on the type of change. Tracked entries are printed | |
320 | in an undefined order; parsers should allow for a mixture of the 3 | |
321 | line types in any order. | |
322 | ||
323 | Ordinary changed entries have the following format: | |
324 | ||
325 | 1 <XY> <sub> <mH> <mI> <mW> <hH> <hI> <path> | |
326 | ||
327 | Renamed or copied entries have the following format: | |
328 | ||
329 | 2 <XY> <sub> <mH> <mI> <mW> <hH> <hI> <X><score> <path><sep><origPath> | |
330 | ||
b62eb1d2 MÅ |
331 | .... |
332 | Field Meaning | |
333 | -------------------------------------------------------- | |
334 | <XY> A 2 character field containing the staged and | |
335 | unstaged XY values described in the short format, | |
336 | with unchanged indicated by a "." rather than | |
337 | a space. | |
338 | <sub> A 4 character field describing the submodule state. | |
339 | "N..." when the entry is not a submodule. | |
340 | "S<c><m><u>" when the entry is a submodule. | |
341 | <c> is "C" if the commit changed; otherwise ".". | |
342 | <m> is "M" if it has tracked changes; otherwise ".". | |
343 | <u> is "U" if there are untracked changes; otherwise ".". | |
344 | <mH> The octal file mode in HEAD. | |
345 | <mI> The octal file mode in the index. | |
346 | <mW> The octal file mode in the worktree. | |
347 | <hH> The object name in HEAD. | |
348 | <hI> The object name in the index. | |
349 | <X><score> The rename or copy score (denoting the percentage | |
350 | of similarity between the source and target of the | |
351 | move or copy). For example "R100" or "C75". | |
352 | <path> The pathname. In a renamed/copied entry, this | |
353 | is the target path. | |
354 | <sep> When the `-z` option is used, the 2 pathnames are separated | |
355 | with a NUL (ASCII 0x00) byte; otherwise, a tab (ASCII 0x09) | |
356 | byte separates them. | |
357 | <origPath> The pathname in the commit at HEAD or in the index. | |
358 | This is only present in a renamed/copied entry, and | |
359 | tells where the renamed/copied contents came from. | |
360 | -------------------------------------------------------- | |
361 | .... | |
1cd828dd JH |
362 | |
363 | Unmerged entries have the following format; the first character is | |
364 | a "u" to distinguish from ordinary changed entries. | |
365 | ||
366 | u <xy> <sub> <m1> <m2> <m3> <mW> <h1> <h2> <h3> <path> | |
367 | ||
b62eb1d2 MÅ |
368 | .... |
369 | Field Meaning | |
370 | -------------------------------------------------------- | |
371 | <XY> A 2 character field describing the conflict type | |
372 | as described in the short format. | |
373 | <sub> A 4 character field describing the submodule state | |
374 | as described above. | |
375 | <m1> The octal file mode in stage 1. | |
376 | <m2> The octal file mode in stage 2. | |
377 | <m3> The octal file mode in stage 3. | |
378 | <mW> The octal file mode in the worktree. | |
379 | <h1> The object name in stage 1. | |
380 | <h2> The object name in stage 2. | |
381 | <h3> The object name in stage 3. | |
382 | <path> The pathname. | |
383 | -------------------------------------------------------- | |
384 | .... | |
1cd828dd | 385 | |
473dd357 TZ |
386 | Other Items |
387 | ^^^^^^^^^^^ | |
1cd828dd JH |
388 | |
389 | Following the tracked entries (and if requested), a series of | |
390 | lines will be printed for untracked and then ignored items | |
391 | found in the worktree. | |
392 | ||
393 | Untracked items have the following format: | |
394 | ||
395 | ? <path> | |
396 | ||
397 | Ignored items have the following format: | |
398 | ||
399 | ! <path> | |
400 | ||
473dd357 TZ |
401 | Pathname Format Notes and -z |
402 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | |
1cd828dd JH |
403 | |
404 | When the `-z` option is given, pathnames are printed as is and | |
405 | without any quoting and lines are terminated with a NUL (ASCII 0x00) | |
406 | byte. | |
407 | ||
860cd699 AH |
408 | Without the `-z` option, pathnames with "unusual" characters are |
409 | quoted as explained for the configuration variable `core.quotePath` | |
410 | (see linkgit:git-config[1]). | |
1cd828dd JH |
411 | |
412 | ||
31fcd63c JH |
413 | CONFIGURATION |
414 | ------------- | |
415 | ||
416 | The command honors `color.status` (or `status.color` -- they | |
417 | mean the same thing and the latter is kept for backward | |
418 | compatibility) and `color.status.<slot>` configuration variables | |
419 | to colorize its output. | |
420 | ||
46f721c8 | 421 | If the config variable `status.relativePaths` is set to false, then all |
482a6c10 MG |
422 | paths shown are relative to the repository root, not to the current |
423 | directory. | |
46f721c8 | 424 | |
da0005b8 | 425 | If `status.submoduleSummary` is set to a non zero number or true (identical |
46b77a6b JK |
426 | to -1 or an unlimited number), the submodule summary will be enabled for |
427 | the long format and a summary of commits for modified submodules will be | |
bb58b696 JL |
428 | shown (see --summary-limit option of linkgit:git-submodule[1]). Please note |
429 | that the summary output from the status command will be suppressed for all | |
430 | submodules when `diff.ignoreSubmodules` is set to 'all' or only for those | |
431 | submodules where `submodule.<name>.ignore=all`. To also view the summary for | |
432 | ignored submodules you can either use the --ignore-submodules=dirty command | |
433 | line option or the 'git submodule summary' command, which shows a similar | |
434 | output but does not honor these settings. | |
ac8d5afc | 435 | |
5e83cca0 JK |
436 | BACKGROUND REFRESH |
437 | ------------------ | |
438 | ||
439 | By default, `git status` will automatically refresh the index, updating | |
440 | the cached stat information from the working tree and writing out the | |
441 | result. Writing out the updated index is an optimization that isn't | |
442 | strictly necessary (`status` computes the values for itself, but writing | |
443 | them out is just to save subsequent programs from repeating our | |
444 | computation). When `status` is run in the background, the lock held | |
445 | during the write may conflict with other simultaneous processes, causing | |
446 | them to fail. Scripts running `status` in the background should consider | |
447 | using `git --no-optional-locks status` (see linkgit:git[1] for details). | |
448 | ||
56ae8df5 | 449 | SEE ALSO |
cedb8d5d | 450 | -------- |
5162e697 | 451 | linkgit:gitignore[5] |
31fcd63c | 452 | |
3f971fc4 JH |
453 | GIT |
454 | --- | |
9e1f0a85 | 455 | Part of the linkgit:git[1] suite |