| blob | 1cae92c95f6352b76245616bec55d34c34702b20 |
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: 2024-04-10
6 .\" Manual: Git Manual
7 .\" Source: Git 2.44.0.568.g436d4e5b14
8 .\" Language: English
9 .\"
10 .TH "GIT\-STATUS" "1" "2024\-04\-10" "Git 2\&.44\&.0\&.568\&.g436d4e" "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\&. All usual spellings for Boolean value
139 \fBtrue\fR
140 are taken as
141 \fBnormal\fR
142 and
143 \fBfalse\fR
144 as
145 \fBno\fR\&.
146 .sp
147 The default can be changed using the status\&.showUntrackedFiles configuration variable documented in
148 \fBgit-config\fR(1)\&.
149 .RE
150 .PP
151 \-\-ignore\-submodules[=<when>]
152 .RS 4
153 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
154 \fIignore\fR
155 option in
156 \fBgit-config\fR(1)
157 or
158 \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
159 \fBstatus\&.submoduleSummary\fR
160 is set)\&.
161 .RE
162 .PP
163 \-\-ignored[=<mode>]
164 .RS 4
165 Show ignored files as well\&.
166 .sp
167 The mode parameter is used to specify the handling of ignored files\&. It is optional: it defaults to
168 \fItraditional\fR\&.
169 .sp
170 The possible options are:
171 .sp
172 .RS 4
173 .ie n \{\
174 \h'-04'\(bu\h'+03'\c
175 .\}
176 .el \{\
177 .sp -1
178 .IP \(bu 2.3
179 .\}
180 \fItraditional\fR
181 \- Shows ignored files and directories, unless \-\-untracked\-files=all is specified, in which case individual files in ignored directories are displayed\&.
182 .RE
183 .sp
184 .RS 4
185 .ie n \{\
186 \h'-04'\(bu\h'+03'\c
187 .\}
188 .el \{\
189 .sp -1
190 .IP \(bu 2.3
191 .\}
192 \fIno\fR
193 \- Show no ignored files\&.
194 .RE
195 .sp
196 .RS 4
197 .ie n \{\
198 \h'-04'\(bu\h'+03'\c
199 .\}
200 .el \{\
201 .sp -1
202 .IP \(bu 2.3
203 .\}
204 \fImatching\fR
205 \- Shows ignored files and directories matching an ignore pattern\&.
206 .RE
207 .sp
208 When
209 \fImatching\fR
210 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\&.
211 .RE
212 .PP
213 \-z
214 .RS 4
215 Terminate entries with NUL, instead of LF\&. This implies the
216 \fB\-\-porcelain=v1\fR
217 output format if no other format is given\&.
218 .RE
219 .PP
220 \-\-column[=<options>], \-\-no\-column
221 .RS 4
222 Display untracked files in columns\&. See configuration variable
223 \fBcolumn\&.status\fR
224 for option syntax\&.
225 \fB\-\-column\fR
226 and
227 \fB\-\-no\-column\fR
228 without options are equivalent to
229 \fIalways\fR
230 and
231 \fInever\fR
232 respectively\&.
233 .RE
234 .PP
235 \-\-ahead\-behind, \-\-no\-ahead\-behind
236 .RS 4
237 Display or do not display detailed ahead/behind counts for the branch relative to its upstream branch\&. Defaults to true\&.
238 .RE
239 .PP
240 \-\-renames, \-\-no\-renames
241 .RS 4
242 Turn on/off rename detection regardless of user configuration\&. See also
243 \fBgit-diff\fR(1)
244 \fB\-\-no\-renames\fR\&.
245 .RE
246 .PP
247 \-\-find\-renames[=<n>]
248 .RS 4
249 Turn on rename detection, optionally setting the similarity threshold\&. See also
250 \fBgit-diff\fR(1)
251 \fB\-\-find\-renames\fR\&.
252 .RE
253 .PP
254 <pathspec>\&...
255 .RS 4
256 See the
257 \fIpathspec\fR
258 entry in
259 \fBgitglossary\fR(7)\&.
260 .RE
261 .SH "OUTPUT"
262 .sp
263 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\&.
264 .sp
265 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\&.
266 .SS "Short Format"
267 .sp
268 In the short\-format, the status of each path is shown as one of these forms
269 .sp
270 .if n \{\
271 .RS 4
272 .\}
273 .nf
274 XY PATH
275 XY ORIG_PATH \-> PATH
276 .fi
277 .if n \{\
278 .RE
279 .\}
280 .sp
281 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\&.
282 .sp
283 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\&.
284 .sp
285 There are three different types of states that are shown using this format, and each one uses the \fBXY\fR syntax differently:
286 .sp
287 .RS 4
288 .ie n \{\
289 \h'-04'\(bu\h'+03'\c
290 .\}
291 .el \{\
292 .sp -1
293 .IP \(bu 2.3
294 .\}
295 When a merge is occurring and the merge was successful, or outside of a merge situation,
296 \fBX\fR
297 shows the status of the index and
298 \fBY\fR
299 shows the status of the working tree\&.
300 .RE
301 .sp
302 .RS 4
303 .ie n \{\
304 \h'-04'\(bu\h'+03'\c
305 .\}
306 .el \{\
307 .sp -1
308 .IP \(bu 2.3
309 .\}
310 When a merge conflict has occurred and has not yet been resolved,
311 \fBX\fR
312 and
313 \fBY\fR
314 show the state introduced by each head of the merge, relative to the common ancestor\&. These paths are said to be
315 \fIunmerged\fR\&.
316 .RE
317 .sp
318 .RS 4
319 .ie n \{\
320 \h'-04'\(bu\h'+03'\c
321 .\}
322 .el \{\
323 .sp -1
324 .IP \(bu 2.3
325 .\}
326 When a path is untracked,
327 \fBX\fR
328 and
329 \fBY\fR
330 are always the same, since they are unknown to the index\&.
331 \fB??\fR
332 is used for untracked paths\&. Ignored files are not listed unless
333 \fB\-\-ignored\fR
334 is used; if it is, ignored files are indicated by
335 \fB!!\fR\&.
336 .RE
337 .sp
338 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\&.
339 .sp
340 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:
341 .sp
342 .RS 4
343 .ie n \{\
344 \h'-04'\(bu\h'+03'\c
345 .\}
346 .el \{\
347 .sp -1
348 .IP \(bu 2.3
349 .\}
350 \*(Aq \*(Aq = unmodified
351 .RE
352 .sp
353 .RS 4
354 .ie n \{\
355 \h'-04'\(bu\h'+03'\c
356 .\}
357 .el \{\
358 .sp -1
359 .IP \(bu 2.3
360 .\}
361 \fIM\fR
362 = modified
363 .RE
364 .sp
365 .RS 4
366 .ie n \{\
367 \h'-04'\(bu\h'+03'\c
368 .\}
369 .el \{\
370 .sp -1
371 .IP \(bu 2.3
372 .\}
373 \fIT\fR
374 = file type changed (regular file, symbolic link or submodule)
375 .RE
376 .sp
377 .RS 4
378 .ie n \{\
379 \h'-04'\(bu\h'+03'\c
380 .\}
381 .el \{\
382 .sp -1
383 .IP \(bu 2.3
384 .\}
385 \fIA\fR
386 = added
387 .RE
388 .sp
389 .RS 4
390 .ie n \{\
391 \h'-04'\(bu\h'+03'\c
392 .\}
393 .el \{\
394 .sp -1
395 .IP \(bu 2.3
396 .\}
397 \fID\fR
398 = deleted
399 .RE
400 .sp
401 .RS 4
402 .ie n \{\
403 \h'-04'\(bu\h'+03'\c
404 .\}
405 .el \{\
406 .sp -1
407 .IP \(bu 2.3
408 .\}
409 \fIR\fR
410 = renamed
411 .RE
412 .sp
413 .RS 4
414 .ie n \{\
415 \h'-04'\(bu\h'+03'\c
416 .\}
417 .el \{\
418 .sp -1
419 .IP \(bu 2.3
420 .\}
421 \fIC\fR
422 = copied (if config option status\&.renames is set to "copies")
423 .RE
424 .sp
425 .RS 4
426 .ie n \{\
427 \h'-04'\(bu\h'+03'\c
428 .\}
429 .el \{\
430 .sp -1
431 .IP \(bu 2.3
432 .\}
433 \fIU\fR
434 = updated but unmerged
435 .RE
436 .sp
437 .if n \{\
438 .RS 4
439 .\}
440 .nf
441 X Y Meaning
442 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
443 [AMD] not updated
444 M [ MTD] updated in index
445 T [ MTD] type changed in index
446 A [ MTD] added to index
447 D deleted from index
448 R [ MTD] renamed in index
449 C [ MTD] copied in index
450 [MTARC] index and work tree matches
451 [ MTARC] M work tree changed since index
452 [ MTARC] T type changed in work tree since index
453 [ MTARC] D deleted in work tree
454 R renamed in work tree
455 C copied in work tree
456 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
457 D D unmerged, both deleted
458 A U unmerged, added by us
459 U D unmerged, deleted by them
460 U A unmerged, added by them
461 D U unmerged, deleted by us
462 A A unmerged, both added
463 U U unmerged, both modified
464 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
465 ? ? untracked
466 ! ! ignored
467 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
468 .fi
469 .if n \{\
470 .RE
471 .\}
472 .sp
473 Submodules have more state and instead report
474 .sp
475 .RS 4
476 .ie n \{\
477 \h'-04'\(bu\h'+03'\c
478 .\}
479 .el \{\
480 .sp -1
481 .IP \(bu 2.3
482 .\}
483 \fIM\fR
484 = the submodule has a different HEAD than recorded in the index
485 .RE
486 .sp
487 .RS 4
488 .ie n \{\
489 \h'-04'\(bu\h'+03'\c
490 .\}
491 .el \{\
492 .sp -1
493 .IP \(bu 2.3
494 .\}
495 \fIm\fR
496 = the submodule has modified content
497 .RE
498 .sp
499 .RS 4
500 .ie n \{\
501 \h'-04'\(bu\h'+03'\c
502 .\}
503 .el \{\
504 .sp -1
505 .IP \(bu 2.3
506 .\}
507 \fI?\fR
508 = the submodule has untracked files
509 .RE
510 .sp
511 This is since modified content or untracked files in a submodule cannot be added via \fBgit add\fR in the superproject to prepare a commit\&.
512 .sp
513 \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\&.
514 .sp
515 If \-b is used the short\-format status is preceded by a line
516 .sp
517 .if n \{\
518 .RS 4
519 .\}
520 .nf
521 ## branchname tracking info
522 .fi
523 .if n \{\
524 .RE
525 .\}
526 .SS "Porcelain Format Version 1"
527 .sp
528 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:
529 .sp
530 .RS 4
531 .ie n \{\
532 \h'-04' 1.\h'+01'\c
533 .\}
534 .el \{\
535 .sp -1
536 .IP " 1." 4.2
537 .\}
538 The user\(cqs color\&.status configuration is not respected; color will always be off\&.
539 .RE
540 .sp
541 .RS 4
542 .ie n \{\
543 \h'-04' 2.\h'+01'\c
544 .\}
545 .el \{\
546 .sp -1
547 .IP " 2." 4.2
548 .\}
549 The user\(cqs status\&.relativePaths configuration is not respected; paths shown will always be relative to the repository root\&.
550 .RE
551 .sp
552 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\&.
553 .sp
554 Any submodule changes are reported as modified \fBM\fR instead of \fBm\fR or single \fB?\fR\&.
555 .SS "Porcelain Format Version 2"
556 .sp
557 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\&.
558 .sp
559 Header lines start with "#" and are added in response to specific command line arguments\&. Parsers should ignore headers they don\(cqt recognize\&.
560 .sp
561 .it 1 an-trap
562 .nr an-no-space-flag 1
563 .nr an-break-flag 1
564 .br
565 .ps +1
566 \fBBranch Headers\fR
567 .RS 4
568 .sp
569 If \fB\-\-branch\fR is given, a series of header lines are printed with information about the current branch\&.
570 .sp
571 .if n \{\
572 .RS 4
573 .\}
574 .nf
575 Line Notes
576 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
577 # branch\&.oid <commit> | (initial) Current commit\&.
578 # branch\&.head <branch> | (detached) Current branch\&.
579 # branch\&.upstream <upstream\-branch> If upstream is set\&.
580 # branch\&.ab +<ahead> \-<behind> If upstream is set and
581 the commit is present\&.
582 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
583 .fi
584 .if n \{\
585 .RE
586 .\}
587 .RE
588 .sp
589 .it 1 an-trap
590 .nr an-no-space-flag 1
591 .nr an-break-flag 1
592 .br
593 .ps +1
594 \fBStash Information\fR
595 .RS 4
596 .sp
597 If \fB\-\-show\-stash\fR is given, one line is printed showing the number of stash entries if non\-zero:
598 .sp
599 .if n \{\
600 .RS 4
601 .\}
602 .nf
603 # stash <N>
604 .fi
605 .if n \{\
606 .RE
607 .\}
608 .RE
609 .sp
610 .it 1 an-trap
611 .nr an-no-space-flag 1
612 .nr an-break-flag 1
613 .br
614 .ps +1
615 \fBChanged Tracked Entries\fR
616 .RS 4
617 .sp
618 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\&.
619 .sp
620 Ordinary changed entries have the following format:
621 .sp
622 .if n \{\
623 .RS 4
624 .\}
625 .nf
626 1 <XY> <sub> <mH> <mI> <mW> <hH> <hI> <path>
627 .fi
628 .if n \{\
629 .RE
630 .\}
631 .sp
632 Renamed or copied entries have the following format:
633 .sp
634 .if n \{\
635 .RS 4
636 .\}
637 .nf
638 2 <XY> <sub> <mH> <mI> <mW> <hH> <hI> <X><score> <path><sep><origPath>
639 .fi
640 .if n \{\
641 .RE
642 .\}
643 .sp
644 .if n \{\
645 .RS 4
646 .\}
647 .nf
648 Field Meaning
649 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
650 <XY> A 2 character field containing the staged and
651 unstaged XY values described in the short format,
652 with unchanged indicated by a "\&." rather than
653 a space\&.
654 <sub> A 4 character field describing the submodule state\&.
655 "N\&.\&.\&." when the entry is not a submodule\&.
656 "S<c><m><u>" when the entry is a submodule\&.
657 <c> is "C" if the commit changed; otherwise "\&."\&.
658 <m> is "M" if it has tracked changes; otherwise "\&."\&.
659 <u> is "U" if there are untracked changes; otherwise "\&."\&.
660 <mH> The octal file mode in HEAD\&.
661 <mI> The octal file mode in the index\&.
662 <mW> The octal file mode in the worktree\&.
663 <hH> The object name in HEAD\&.
664 <hI> The object name in the index\&.
665 <X><score> The rename or copy score (denoting the percentage
666 of similarity between the source and target of the
667 move or copy)\&. For example "R100" or "C75"\&.
668 <path> The pathname\&. In a renamed/copied entry, this
669 is the target path\&.
670 <sep> When the `\-z` option is used, the 2 pathnames are separated
671 with a NUL (ASCII 0x00) byte; otherwise, a tab (ASCII 0x09)
672 byte separates them\&.
673 <origPath> The pathname in the commit at HEAD or in the index\&.
674 This is only present in a renamed/copied entry, and
675 tells where the renamed/copied contents came from\&.
676 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
677 .fi
678 .if n \{\
679 .RE
680 .\}
681 .sp
682 Unmerged entries have the following format; the first character is a "u" to distinguish from ordinary changed entries\&.
683 .sp
684 .if n \{\
685 .RS 4
686 .\}
687 .nf
688 u <XY> <sub> <m1> <m2> <m3> <mW> <h1> <h2> <h3> <path>
689 .fi
690 .if n \{\
691 .RE
692 .\}
693 .sp
694 .if n \{\
695 .RS 4
696 .\}
697 .nf
698 Field Meaning
699 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
700 <XY> A 2 character field describing the conflict type
701 as described in the short format\&.
702 <sub> A 4 character field describing the submodule state
703 as described above\&.
704 <m1> The octal file mode in stage 1\&.
705 <m2> The octal file mode in stage 2\&.
706 <m3> The octal file mode in stage 3\&.
707 <mW> The octal file mode in the worktree\&.
708 <h1> The object name in stage 1\&.
709 <h2> The object name in stage 2\&.
710 <h3> The object name in stage 3\&.
711 <path> The pathname\&.
712 \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
713 .fi
714 .if n \{\
715 .RE
716 .\}
717 .RE
718 .sp
719 .it 1 an-trap
720 .nr an-no-space-flag 1
721 .nr an-break-flag 1
722 .br
723 .ps +1
724 \fBOther Items\fR
725 .RS 4
726 .sp
727 Following the tracked entries (and if requested), a series of lines will be printed for untracked and then ignored items found in the worktree\&.
728 .sp
729 Untracked items have the following format:
730 .sp
731 .if n \{\
732 .RS 4
733 .\}
734 .nf
735 ? <path>
736 .fi
737 .if n \{\
738 .RE
739 .\}
740 .sp
741 Ignored items have the following format:
742 .sp
743 .if n \{\
744 .RS 4
745 .\}
746 .nf
747 ! <path>
748 .fi
749 .if n \{\
750 .RE
751 .\}
752 .RE
753 .sp
754 .it 1 an-trap
755 .nr an-no-space-flag 1
756 .nr an-break-flag 1
757 .br
758 .ps +1
759 \fBPathname Format Notes and -z\fR
760 .RS 4
761 .sp
762 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\&.
763 .sp
764 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))\&.
765 .RE
766 .SH "CONFIGURATION"
767 .sp
768 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\&.
769 .sp
770 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\&.
771 .sp
772 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\&.
773 .SH "BACKGROUND REFRESH"
774 .sp
775 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)\&.
776 .SH "UNTRACKED FILES AND PERFORMANCE"
777 .sp
778 \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\&.
779 .sp
780 .RS 4
781 .ie n \{\
782 \h'-04'\(bu\h'+03'\c
783 .\}
784 .el \{\
785 .sp -1
786 .IP \(bu 2.3
787 .\}
788 The
789 \fB\-\-untracked\-files=no\fR
790 flag or the
791 \fBstatus\&.showUntrackedFiles=no\fR
792 config (see above for both): indicate that
793 \fBgit status\fR
794 should not report untracked files\&. This is the fastest option\&.
795 \fBgit status\fR
796 will not list the untracked files, so you need to be careful to remember if you create any new files and manually
797 \fBgit add\fR
798 them\&.
799 .RE
800 .sp
801 .RS 4
802 .ie n \{\
803 \h'-04'\(bu\h'+03'\c
804 .\}
805 .el \{\
806 .sp -1
807 .IP \(bu 2.3
808 .\}
809 \fBadvice\&.statusUoption=false\fR
810 (see
811 \fBgit-config\fR(1)): setting this variable to
812 \fBfalse\fR
813 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\&.
814 .RE
815 .sp
816 .RS 4
817 .ie n \{\
818 \h'-04'\(bu\h'+03'\c
819 .\}
820 .el \{\
821 .sp -1
822 .IP \(bu 2.3
823 .\}
824 \fBcore\&.untrackedCache=true\fR
825 (see
826 \fBgit-update-index\fR(1)): enable the untracked cache feature and only search directories that have been modified since the previous
827 \fBgit status\fR
828 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
829 \fB\&.git/index\fR
830 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\&.
831 .RE
832 .sp
833 .RS 4
834 .ie n \{\
835 \h'-04'\(bu\h'+03'\c
836 .\}
837 .el \{\
838 .sp -1
839 .IP \(bu 2.3
840 .\}
841 \fBcore\&.untrackedCache=true\fR
842 and
843 \fBcore\&.fsmonitor=true\fR
844 or
845 \fBcore\&.fsmonitor=<hook\-command\-pathname>\fR
846 (see
847 \fBgit-update-index\fR(1)): enable both the untracked cache and FSMonitor features and only search directories that have been modified since the previous
848 \fBgit status\fR
849 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\&.
850 .RE
851 .sp
852 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\&.
853 .SH "SEE ALSO"
854 .sp
855 \fBgitignore\fR(5)
856 .SH "GIT"
857 .sp
858 Part of the \fBgit\fR(1) suite