| blob | 5fe0da91b56f64ff7ebe513b5eb6c6be319856fb |
1 '\" t
2 .\" Title: git-status
3 .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5 .\" Date: 01/17/2023
6 .\" Manual: Git Manual
7 .\" Source: Git 2.39.1.231.ga7caae2729
8 .\" Language: English
9 .\"
10 .TH "GIT\-STATUS" "1" "01/17/2023" "Git 2\&.39\&.1\&.231\&.ga7caae" "Git Manual"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 git-status \- Show the working tree status
32 .SH "SYNOPSIS"
33 .sp
34 .nf
35 \fIgit status\fR [<options>] [\-\-] [<pathspec>\&...]
36 .fi
37 .sp
38 .SH "DESCRIPTION"
39 .sp
40 Displays paths that have differences between the index file and the current HEAD commit, paths that have differences between the working tree and the index file, and paths in the working tree that are not tracked by Git (and are not ignored by \fBgitignore\fR(5))\&. The first are what you \fIwould\fR commit by running \fBgit commit\fR; the second and third are what you \fIcould\fR commit by running \fIgit add\fR before running \fBgit commit\fR\&.
41 .SH "OPTIONS"
42 .PP
43 \-s, \-\-short
44 .RS 4
45 Give the output in the short\-format\&.
46 .RE
47 .PP
48 \-b, \-\-branch
49 .RS 4
50 Show the branch and tracking info even in short\-format\&.
51 .RE
52 .PP
53 \-\-show\-stash
54 .RS 4
55 Show the number of entries currently stashed away\&.
56 .RE
57 .PP
58 \-\-porcelain[=<version>]
59 .RS 4
60 Give the output in an easy\-to\-parse format for scripts\&. This is similar to the short output, but will remain stable across Git versions and regardless of user configuration\&. See below for details\&.
61 .sp
62 The version parameter is used to specify the format version\&. This is optional and defaults to the original version
63 \fIv1\fR
64 format\&.
65 .RE
66 .PP
67 \-\-long
68 .RS 4
69 Give the output in the long\-format\&. This is the default\&.
70 .RE
71 .PP
72 \-v, \-\-verbose
73 .RS 4
74 In addition to the names of files that have been changed, also show the textual changes that are staged to be committed (i\&.e\&., like the output of
75 \fBgit diff \-\-cached\fR)\&. If
76 \fB\-v\fR
77 is specified twice, then also show the changes in the working tree that have not yet been staged (i\&.e\&., like the output of
78 \fBgit diff\fR)\&.
79 .RE
80 .PP
81 \-u[<mode>], \-\-untracked\-files[=<mode>]
82 .RS 4
83 Show untracked files\&.
84 .sp
85 The mode parameter is used to specify the handling of untracked files\&. It is optional: it defaults to
86 \fIall\fR, and if specified, it must be stuck to the option (e\&.g\&.
87 \fB\-uno\fR, but not
88 \fB\-u no\fR)\&.
89 .sp
90 The possible options are:
91 .sp
92 .RS 4
93 .ie n \{\
94 \h'-04'\(bu\h'+03'\c
95 .\}
96 .el \{\
97 .sp -1
98 .IP \(bu 2.3
99 .\}
100 \fIno\fR
101 \- Show no untracked files\&.
102 .RE
103 .sp
104 .RS 4
105 .ie n \{\
106 \h'-04'\(bu\h'+03'\c
107 .\}
108 .el \{\
109 .sp -1
110 .IP \(bu 2.3
111 .\}
112 \fInormal\fR
113 \- Shows untracked files and directories\&.
114 .RE
115 .sp
116 .RS 4
117 .ie n \{\
118 \h'-04'\(bu\h'+03'\c
119 .\}
120 .el \{\
121 .sp -1
122 .IP \(bu 2.3
123 .\}
124 \fIall\fR
125 \- Also shows individual files in untracked directories\&.
126 .RE
127 .sp
128 When
129 \fB\-u\fR
130 option is not used, untracked files and directories are shown (i\&.e\&. the same as specifying
131 \fBnormal\fR), to help you avoid forgetting to add newly created files\&. Because it takes extra work to find untracked files in the filesystem, this mode may take some time in a large working tree\&. Consider enabling untracked cache and split index if supported (see
132 \fBgit update\-index \-\-untracked\-cache\fR
133 and
134 \fBgit update\-index \-\-split\-index\fR), Otherwise you can use
135 \fBno\fR
136 to have
137 \fBgit status\fR
138 return more quickly without showing untracked files\&.
139 .sp
140 The default can be changed using the status\&.showUntrackedFiles configuration variable documented in
141 \fBgit-config\fR(1)\&.
142 .RE
143 .PP
144 \-\-ignore\-submodules[=<when>]
145 .RS 4
146 Ignore changes to submodules when looking for changes\&. <when> can be either "none", "untracked", "dirty" or "all", which is the default\&. Using "none" will consider the submodule modified when it either contains untracked or modified files or its HEAD differs from the commit recorded in the superproject and can be used to override any settings of the
147 \fIignore\fR
148 option in
149 \fBgit-config\fR(1)
150 or
151 \fBgitmodules\fR(5)\&. When "untracked" is used submodules are not considered dirty when they only contain untracked content (but they are still scanned for modified content)\&. Using "dirty" ignores all changes to the work tree of submodules, only changes to the commits stored in the superproject are shown (this was the behavior before 1\&.7\&.0)\&. Using "all" hides all changes to submodules (and suppresses the output of submodule summaries when the config option
152 \fBstatus\&.submoduleSummary\fR
153 is set)\&.
154 .RE
155 .PP
156 \-\-ignored[=<mode>]
157 .RS 4
158 Show ignored files as well\&.
159 .sp
160 The mode parameter is used to specify the handling of ignored files\&. It is optional: it defaults to
161 \fItraditional\fR\&.
162 .sp
163 The possible options are:
164 .sp
165 .RS 4
166 .ie n \{\
167 \h'-04'\(bu\h'+03'\c
168 .\}
169 .el \{\
170 .sp -1
171 .IP \(bu 2.3
172 .\}
173 \fItraditional\fR
174 \- Shows ignored files and directories, unless \-\-untracked\-files=all is specified, in which case individual files in ignored directories are displayed\&.
175 .RE
176 .sp
177 .RS 4
178 .ie n \{\
179 \h'-04'\(bu\h'+03'\c
180 .\}
181 .el \{\
182 .sp -1
183 .IP \(bu 2.3
184 .\}
185 \fIno\fR
186 \- Show no ignored files\&.
187 .RE
188 .sp
189 .RS 4
190 .ie n \{\
191 \h'-04'\(bu\h'+03'\c
192 .\}
193 .el \{\
194 .sp -1
195 .IP \(bu 2.3
196 .\}
197 \fImatching\fR
198 \- Shows ignored files and directories matching an ignore pattern\&.
199 .RE
200 .sp
201 When
202 \fImatching\fR
203 mode is specified, paths that explicitly match an ignored pattern are shown\&. If a directory matches an ignore pattern, then it is shown, but not paths contained in the ignored directory\&. If a directory does not match an ignore pattern, but all contents are ignored, then the directory is not shown, but all contents are shown\&.
204 .RE
205 .PP
206 \-z
207 .RS 4
208 Terminate entries with NUL, instead of LF\&. This implies the
209 \fB\-\-porcelain=v1\fR
210 output format if no other format is given\&.
211 .RE
212 .PP
213 \-\-column[=<options>], \-\-no\-column
214 .RS 4
215 Display untracked files in columns\&. See configuration variable
216 \fBcolumn\&.status\fR
217 for option syntax\&.
218 \fB\-\-column\fR
219 and
220 \fB\-\-no\-column\fR
221 without options are equivalent to
222 \fIalways\fR
223 and
224 \fInever\fR
225 respectively\&.
226 .RE
227 .PP
228 \-\-ahead\-behind, \-\-no\-ahead\-behind
229 .RS 4
230 Display or do not display detailed ahead/behind counts for the branch relative to its upstream branch\&. Defaults to true\&.
231 .RE
232 .PP
233 \-\-renames, \-\-no\-renames
234 .RS 4
235 Turn on/off rename detection regardless of user configuration\&. See also
236 \fBgit-diff\fR(1)
237 \fB\-\-no\-renames\fR\&.
238 .RE
239 .PP
240 \-\-find\-renames[=<n>]
241 .RS 4
242 Turn on rename detection, optionally setting the similarity threshold\&. See also
243 \fBgit-diff\fR(1)
244 \fB\-\-find\-renames\fR\&.
245 .RE
246 .PP
247 <pathspec>\&...
248 .RS 4
249 See the
250 \fIpathspec\fR
251 entry in
252 \fBgitglossary\fR(7)\&.
253 .RE
254 .SH "OUTPUT"
255 .sp
256 The output from this command is designed to be used as a commit template comment\&. The default, long format, is designed to be human readable, verbose and descriptive\&. Its contents and format are subject to change at any time\&.
257 .sp
258 The paths mentioned in the output, unlike many other Git commands, are made relative to the current directory if you are working in a subdirectory (this is on purpose, to help cutting and pasting)\&. See the status\&.relativePaths config option below\&.
259 .SS "Short Format"
260 .sp
261 In the short\-format, the status of each path is shown as one of these forms
262 .sp
263 .if n \{\
264 .RS 4
265 .\}
266 .nf
267 XY PATH
268 XY ORIG_PATH \-> PATH
269 .fi
270 .if n \{\
271 .RE
272 .\}
273 .sp
274 where \fBORIG_PATH\fR is where the renamed/copied contents came from\&. \fBORIG_PATH\fR is only shown when the entry is renamed or copied\&. The \fBXY\fR is a two\-letter status code\&.
275 .sp
276 The fields (including the \fB\->\fR) are separated from each other by a single space\&. If a filename contains whitespace or other nonprintable characters, that field will be quoted in the manner of a C string literal: surrounded by ASCII double quote (34) characters, and with interior special characters backslash\-escaped\&.
277 .sp
278 There are three different types of states that are shown using this format, and each one uses the \fBXY\fR syntax differently:
279 .sp
280 .RS 4
281 .ie n \{\
282 \h'-04'\(bu\h'+03'\c
283 .\}
284 .el \{\
285 .sp -1
286 .IP \(bu 2.3
287 .\}
288 When a merge is occurring and the merge was successful, or outside of a merge situation,
289 \fBX\fR
290 shows the status of the index and
291 \fBY\fR
292 shows the status of the working tree\&.
293 .RE
294 .sp
295 .RS 4
296 .ie n \{\
297 \h'-04'\(bu\h'+03'\c
298 .\}
299 .el \{\
300 .sp -1
301 .IP \(bu 2.3
302 .\}
303 When a merge conflict has occurred and has not yet been resolved,
304 \fBX\fR
305 and
306 \fBY\fR
307 show the state introduced by each head of the merge, relative to the common ancestor\&. These paths are said to be
308 \fIunmerged\fR\&.
309 .RE
310 .sp
311 .RS 4
312 .ie n \{\
313 \h'-04'\(bu\h'+03'\c
314 .\}
315 .el \{\
316 .sp -1
317 .IP \(bu 2.3
318 .\}
319 When a path is untracked,
320 \fBX\fR
321 and
322 \fBY\fR
323 are always the same, since they are unknown to the index\&.
324 \fB??\fR
325 is used for untracked paths\&. Ignored files are not listed unless
326 \fB\-\-ignored\fR
327 is used; if it is, ignored files are indicated by
328 \fB!!\fR\&.
329 .RE
330 .sp
331 Note that the term \fImerge\fR here also includes rebases using the default \fB\-\-merge\fR strategy, cherry\-picks, and anything else using the merge machinery\&.
332 .sp
333 In the following table, these three classes are shown in separate sections, and these characters are used for \fBX\fR and \fBY\fR fields for the first two sections that show tracked paths:
334 .sp
335 .RS 4
336 .ie n \{\
337 \h'-04'\(bu\h'+03'\c
338 .\}
339 .el \{\
340 .sp -1
341 .IP \(bu 2.3
342 .\}
343 \(aq \(aq = unmodified
344 .RE
345 .sp
346 .RS 4
347 .ie n \{\
348 \h'-04'\(bu\h'+03'\c
349 .\}
350 .el \{\
351 .sp -1
352 .IP \(bu 2.3
353 .\}
354 \fIM\fR
355 = modified
356 .RE
357 .sp
358 .RS 4
359 .ie n \{\
360 \h'-04'\(bu\h'+03'\c
361 .\}
362 .el \{\
363 .sp -1
364 .IP \(bu 2.3
365 .\}
366 \fIT\fR
367 = file type changed (regular file, symbolic link or submodule)
368 .RE
369 .sp
370 .RS 4
371 .ie n \{\
372 \h'-04'\(bu\h'+03'\c
373 .\}
374 .el \{\
375 .sp -1
376 .IP \(bu 2.3
377 .\}
378 \fIA\fR
379 = added
380 .RE
381 .sp
382 .RS 4
383 .ie n \{\
384 \h'-04'\(bu\h'+03'\c
385 .\}
386 .el \{\
387 .sp -1
388 .IP \(bu 2.3
389 .\}
390 \fID\fR
391 = deleted
392 .RE
393 .sp
394 .RS 4
395 .ie n \{\
396 \h'-04'\(bu\h'+03'\c
397 .\}
398 .el \{\
399 .sp -1
400 .IP \(bu 2.3
401 .\}
402 \fIR\fR
403 = renamed
404 .RE
405 .sp
406 .RS 4
407 .ie n \{\
408 \h'-04'\(bu\h'+03'\c
409 .\}
410 .el \{\
411 .sp -1
412 .IP \(bu 2.3
413 .\}
414 \fIC\fR
415 = copied (if config option status\&.renames is set to "copies")
416 .RE
417 .sp
418 .RS 4
419 .ie n \{\
420 \h'-04'\(bu\h'+03'\c
421 .\}
422 .el \{\
423 .sp -1
424 .IP \(bu 2.3
425 .\}
426 \fIU\fR
427 = updated but unmerged
428 .RE
429 .sp
430 .if n \{\
431 .RS 4
432 .\}
433 .nf
434 X Y Meaning
435 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
436 [AMD] not updated
437 M [ MTD] updated in index
438 T [ MTD] type changed in index
439 A [ MTD] added to index
440 D deleted from index
441 R [ MTD] renamed in index
442 C [ MTD] copied in index
443 [MTARC] index and work tree matches
444 [ MTARC] M work tree changed since index
445 [ MTARC] T type changed in work tree since index
446 [ MTARC] D deleted in work tree
447 R renamed in work tree
448 C copied in work tree
449 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
450 D D unmerged, both deleted
451 A U unmerged, added by us
452 U D unmerged, deleted by them
453 U A unmerged, added by them
454 D U unmerged, deleted by us
455 A A unmerged, both added
456 U U unmerged, both modified
457 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
458 ? ? untracked
459 ! ! ignored
460 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
461 .fi
462 .if n \{\
463 .RE
464 .\}
465 .sp
466 Submodules have more state and instead report M the submodule has a different HEAD than recorded in the index m the submodule has modified content ? the submodule has untracked files since modified content or untracked files in a submodule cannot be added via \fBgit add\fR in the superproject to prepare a commit\&.
467 .sp
468 \fIm\fR and \fI?\fR are applied recursively\&. For example if a nested submodule in a submodule contains an untracked file, this is reported as \fI?\fR as well\&.
469 .sp
470 If \-b is used the short\-format status is preceded by a line
471 .sp
472 .if n \{\
473 .RS 4
474 .\}
475 .nf
476 ## branchname tracking info
477 .fi
478 .if n \{\
479 .RE
480 .\}
481 .SS "Porcelain Format Version 1"
482 .sp
483 Version 1 porcelain format is similar to the short format, but is guaranteed not to change in a backwards\-incompatible way between Git versions or based on user configuration\&. This makes it ideal for parsing by scripts\&. The description of the short format above also describes the porcelain format, with a few exceptions:
484 .sp
485 .RS 4
486 .ie n \{\
487 \h'-04' 1.\h'+01'\c
488 .\}
489 .el \{\
490 .sp -1
491 .IP " 1." 4.2
492 .\}
493 The user\(cqs color\&.status configuration is not respected; color will always be off\&.
494 .RE
495 .sp
496 .RS 4
497 .ie n \{\
498 \h'-04' 2.\h'+01'\c
499 .\}
500 .el \{\
501 .sp -1
502 .IP " 2." 4.2
503 .\}
504 The user\(cqs status\&.relativePaths configuration is not respected; paths shown will always be relative to the repository root\&.
505 .RE
506 .sp
507 There is also an alternate \-z format recommended for machine parsing\&. In that format, the status field is the same, but some other things change\&. First, the \fI\->\fR is omitted from rename entries and the field order is reversed (e\&.g \fIfrom \-> to\fR becomes \fIto from\fR)\&. Second, a NUL (ASCII 0) follows each filename, replacing space as a field separator and the terminating newline (but a space still separates the status field from the first filename)\&. Third, filenames containing special characters are not specially formatted; no quoting or backslash\-escaping is performed\&.
508 .sp
509 Any submodule changes are reported as modified \fBM\fR instead of \fBm\fR or single \fB?\fR\&.
510 .SS "Porcelain Format Version 2"
511 .sp
512 Version 2 format adds more detailed information about the state of the worktree and changed items\&. Version 2 also defines an extensible set of easy to parse optional headers\&.
513 .sp
514 Header lines start with "#" and are added in response to specific command line arguments\&. Parsers should ignore headers they don\(cqt recognize\&.
515 .sp
516 .it 1 an-trap
517 .nr an-no-space-flag 1
518 .nr an-break-flag 1
519 .br
520 .ps +1
521 \fBBranch Headers\fR
522 .RS 4
523 .sp
524 If \fB\-\-branch\fR is given, a series of header lines are printed with information about the current branch\&.
525 .sp
526 .if n \{\
527 .RS 4
528 .\}
529 .nf
530 Line Notes
531 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
532 # branch\&.oid <commit> | (initial) Current commit\&.
533 # branch\&.head <branch> | (detached) Current branch\&.
534 # branch\&.upstream <upstream_branch> If upstream is set\&.
535 # branch\&.ab +<ahead> \-<behind> If upstream is set and
536 the commit is present\&.
537 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
538 .fi
539 .if n \{\
540 .RE
541 .\}
542 .RE
543 .sp
544 .it 1 an-trap
545 .nr an-no-space-flag 1
546 .nr an-break-flag 1
547 .br
548 .ps +1
549 \fBStash Information\fR
550 .RS 4
551 .sp
552 If \fB\-\-show\-stash\fR is given, one line is printed showing the number of stash entries if non\-zero:
553 .sp
554 .if n \{\
555 .RS 4
556 .\}
557 .nf
558 # stash <N>
559 .fi
560 .if n \{\
561 .RE
562 .\}
563 .RE
564 .sp
565 .it 1 an-trap
566 .nr an-no-space-flag 1
567 .nr an-break-flag 1
568 .br
569 .ps +1
570 \fBChanged Tracked Entries\fR
571 .RS 4
572 .sp
573 Following the headers, a series of lines are printed for tracked entries\&. One of three different line formats may be used to describe an entry depending on the type of change\&. Tracked entries are printed in an undefined order; parsers should allow for a mixture of the 3 line types in any order\&.
574 .sp
575 Ordinary changed entries have the following format:
576 .sp
577 .if n \{\
578 .RS 4
579 .\}
580 .nf
581 1 <XY> <sub> <mH> <mI> <mW> <hH> <hI> <path>
582 .fi
583 .if n \{\
584 .RE
585 .\}
586 .sp
587 Renamed or copied entries have the following format:
588 .sp
589 .if n \{\
590 .RS 4
591 .\}
592 .nf
593 2 <XY> <sub> <mH> <mI> <mW> <hH> <hI> <X><score> <path><sep><origPath>
594 .fi
595 .if n \{\
596 .RE
597 .\}
598 .sp
599 .if n \{\
600 .RS 4
601 .\}
602 .nf
603 Field Meaning
604 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
605 <XY> A 2 character field containing the staged and
606 unstaged XY values described in the short format,
607 with unchanged indicated by a "\&." rather than
608 a space\&.
609 <sub> A 4 character field describing the submodule state\&.
610 "N\&.\&.\&." when the entry is not a submodule\&.
611 "S<c><m><u>" when the entry is a submodule\&.
612 <c> is "C" if the commit changed; otherwise "\&."\&.
613 <m> is "M" if it has tracked changes; otherwise "\&."\&.
614 <u> is "U" if there are untracked changes; otherwise "\&."\&.
615 <mH> The octal file mode in HEAD\&.
616 <mI> The octal file mode in the index\&.
617 <mW> The octal file mode in the worktree\&.
618 <hH> The object name in HEAD\&.
619 <hI> The object name in the index\&.
620 <X><score> The rename or copy score (denoting the percentage
621 of similarity between the source and target of the
622 move or copy)\&. For example "R100" or "C75"\&.
623 <path> The pathname\&. In a renamed/copied entry, this
624 is the target path\&.
625 <sep> When the `\-z` option is used, the 2 pathnames are separated
626 with a NUL (ASCII 0x00) byte; otherwise, a tab (ASCII 0x09)
627 byte separates them\&.
628 <origPath> The pathname in the commit at HEAD or in the index\&.
629 This is only present in a renamed/copied entry, and
630 tells where the renamed/copied contents came from\&.
631 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
632 .fi
633 .if n \{\
634 .RE
635 .\}
636 .sp
637 Unmerged entries have the following format; the first character is a "u" to distinguish from ordinary changed entries\&.
638 .sp
639 .if n \{\
640 .RS 4
641 .\}
642 .nf
643 u <XY> <sub> <m1> <m2> <m3> <mW> <h1> <h2> <h3> <path>
644 .fi
645 .if n \{\
646 .RE
647 .\}
648 .sp
649 .if n \{\
650 .RS 4
651 .\}
652 .nf
653 Field Meaning
654 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
655 <XY> A 2 character field describing the conflict type
656 as described in the short format\&.
657 <sub> A 4 character field describing the submodule state
658 as described above\&.
659 <m1> The octal file mode in stage 1\&.
660 <m2> The octal file mode in stage 2\&.
661 <m3> The octal file mode in stage 3\&.
662 <mW> The octal file mode in the worktree\&.
663 <h1> The object name in stage 1\&.
664 <h2> The object name in stage 2\&.
665 <h3> The object name in stage 3\&.
666 <path> The pathname\&.
667 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
668 .fi
669 .if n \{\
670 .RE
671 .\}
672 .RE
673 .sp
674 .it 1 an-trap
675 .nr an-no-space-flag 1
676 .nr an-break-flag 1
677 .br
678 .ps +1
679 \fBOther Items\fR
680 .RS 4
681 .sp
682 Following the tracked entries (and if requested), a series of lines will be printed for untracked and then ignored items found in the worktree\&.
683 .sp
684 Untracked items have the following format:
685 .sp
686 .if n \{\
687 .RS 4
688 .\}
689 .nf
690 ? <path>
691 .fi
692 .if n \{\
693 .RE
694 .\}
695 .sp
696 Ignored items have the following format:
697 .sp
698 .if n \{\
699 .RS 4
700 .\}
701 .nf
702 ! <path>
703 .fi
704 .if n \{\
705 .RE
706 .\}
707 .RE
708 .sp
709 .it 1 an-trap
710 .nr an-no-space-flag 1
711 .nr an-break-flag 1
712 .br
713 .ps +1
714 \fBPathname Format Notes and -z\fR
715 .RS 4
716 .sp
717 When the \fB\-z\fR option is given, pathnames are printed as is and without any quoting and lines are terminated with a NUL (ASCII 0x00) byte\&.
718 .sp
719 Without the \fB\-z\fR option, pathnames with "unusual" characters are quoted as explained for the configuration variable \fBcore\&.quotePath\fR (see \fBgit-config\fR(1))\&.
720 .RE
721 .SH "CONFIGURATION"
722 .sp
723 The command honors \fBcolor\&.status\fR (or \fBstatus\&.color\fR \(em they mean the same thing and the latter is kept for backward compatibility) and \fBcolor\&.status\&.<slot>\fR configuration variables to colorize its output\&.
724 .sp
725 If the config variable \fBstatus\&.relativePaths\fR is set to false, then all paths shown are relative to the repository root, not to the current directory\&.
726 .sp
727 If \fBstatus\&.submoduleSummary\fR is set to a non zero number or true (identical to \-1 or an unlimited number), the submodule summary will be enabled for the long format and a summary of commits for modified submodules will be shown (see \-\-summary\-limit option of \fBgit-submodule\fR(1))\&. Please note that the summary output from the status command will be suppressed for all submodules when \fBdiff\&.ignoreSubmodules\fR is set to \fIall\fR or only for those submodules where \fBsubmodule\&.<name>\&.ignore=all\fR\&. To also view the summary for ignored submodules you can either use the \-\-ignore\-submodules=dirty command line option or the \fIgit submodule summary\fR command, which shows a similar output but does not honor these settings\&.
728 .SH "BACKGROUND REFRESH"
729 .sp
730 By default, \fBgit status\fR will automatically refresh the index, updating the cached stat information from the working tree and writing out the result\&. Writing out the updated index is an optimization that isn\(cqt strictly necessary (\fBstatus\fR computes the values for itself, but writing them out is just to save subsequent programs from repeating our computation)\&. When \fBstatus\fR is run in the background, the lock held during the write may conflict with other simultaneous processes, causing them to fail\&. Scripts running \fBstatus\fR in the background should consider using \fBgit \-\-no\-optional\-locks status\fR (see \fBgit\fR(1) for details)\&.
731 .SH "UNTRACKED FILES AND PERFORMANCE"
732 .sp
733 \fBgit status\fR can be very slow in large worktrees if/when it needs to search for untracked files and directories\&. There are many configuration options available to speed this up by either avoiding the work or making use of cached results from previous Git commands\&. There is no single optimum set of settings right for everyone\&. We\(cqll list a summary of the relevant options to help you, but before going into the list, you may want to run \fBgit status\fR again, because your configuration may already be caching \fBgit status\fR results, so it could be faster on subsequent runs\&.
734 .sp
735 .RS 4
736 .ie n \{\
737 \h'-04'\(bu\h'+03'\c
738 .\}
739 .el \{\
740 .sp -1
741 .IP \(bu 2.3
742 .\}
743 The
744 \fB\-\-untracked\-files=no\fR
745 flag or the
746 \fBstatus\&.showUntrackedfiles=false\fR
747 config (see above for both): indicate that
748 \fBgit status\fR
749 should not report untracked files\&. This is the fastest option\&.
750 \fBgit status\fR
751 will not list the untracked files, so you need to be careful to remember if you create any new files and manually
752 \fBgit add\fR
753 them\&.
754 .RE
755 .sp
756 .RS 4
757 .ie n \{\
758 \h'-04'\(bu\h'+03'\c
759 .\}
760 .el \{\
761 .sp -1
762 .IP \(bu 2.3
763 .\}
764 \fBadvice\&.statusUoption=false\fR
765 (see
766 \fBgit-config\fR(1)): setting this variable to
767 \fBfalse\fR
768 disables the warning message given when enumerating untracked files takes more than 2 seconds\&. In a large project, it may take longer and the user may have already accepted the trade off (e\&.g\&. using "\-uno" may not be an acceptable option for the user), in which case, there is no point issuing the warning message, and in such a case, disabling the warning may be the best\&.
769 .RE
770 .sp
771 .RS 4
772 .ie n \{\
773 \h'-04'\(bu\h'+03'\c
774 .\}
775 .el \{\
776 .sp -1
777 .IP \(bu 2.3
778 .\}
779 \fBcore\&.untrackedCache=true\fR
780 (see
781 \fBgit-update-index\fR(1)): enable the untracked cache feature and only search directories that have been modified since the previous
782 \fBgit status\fR
783 command\&. Git remembers the set of untracked files within each directory and assumes that if a directory has not been modified, then the set of untracked files within has not changed\&. This is much faster than enumerating the contents of every directory, but still not without cost, because Git still has to search for the set of modified directories\&. The untracked cache is stored in the
784 \fB\&.git/index\fR
785 file\&. The reduced cost of searching for untracked files is offset slightly by the increased size of the index and the cost of keeping it up\-to\-date\&. That reduced search time is usually worth the additional size\&.
786 .RE
787 .sp
788 .RS 4
789 .ie n \{\
790 \h'-04'\(bu\h'+03'\c
791 .\}
792 .el \{\
793 .sp -1
794 .IP \(bu 2.3
795 .\}
796 \fBcore\&.untrackedCache=true\fR
797 and
798 \fBcore\&.fsmonitor=true\fR
799 or
800 \fBcore\&.fsmonitor=<hook_command_pathname>\fR
801 (see
802 \fBgit-update-index\fR(1)): enable both the untracked cache and FSMonitor features and only search directories that have been modified since the previous
803 \fBgit status\fR
804 command\&. This is faster than using just the untracked cache alone because Git can also avoid searching for modified directories\&. Git only has to enumerate the exact set of directories that have changed recently\&. While the FSMonitor feature can be enabled without the untracked cache, the benefits are greatly reduced in that case\&.
805 .RE
806 .sp
807 Note that after you turn on the untracked cache and/or FSMonitor features it may take a few \fBgit status\fR commands for the various caches to warm up before you see improved command times\&. This is normal\&.
808 .SH "SEE ALSO"
809 .sp
810 \fBgitignore\fR(5)
811 .SH "GIT"
812 .sp
813 Part of the \fBgit\fR(1) suite