]>
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 | ||
6f157871 | 35 | --porcelain:: |
fc17df03 JK |
36 | Give the output in an easy-to-parse format for scripts. |
37 | This is similar to the short output, but will remain stable | |
2de9b711 | 38 | across Git versions and regardless of user configuration. See |
fc17df03 | 39 | below for details. |
6f157871 | 40 | |
f3f47a1e JK |
41 | --long:: |
42 | Give the output in the long-format. This is the default. | |
43 | ||
9c589d97 MH |
44 | -v:: |
45 | --verbose:: | |
46 | In addition to the names of files that have been changed, also | |
47 | show the textual changes that are staged to be committed | |
48 | (i.e., like the output of `git diff --cached`). If `-v` is specified | |
49 | twice, then also show the changes in the working tree that | |
50 | have not yet been staged (i.e., like the output of `git diff`). | |
51 | ||
9e4b7ab6 JH |
52 | -u[<mode>]:: |
53 | --untracked-files[=<mode>]:: | |
4cc62606 | 54 | Show untracked files. |
9e4b7ab6 | 55 | + |
4cc62606 | 56 | The mode parameter is optional (defaults to 'all'), and is used to |
5823eb2b | 57 | specify the handling of untracked files. |
4cc62606 CB |
58 | + |
59 | The possible options are: | |
9e4b7ab6 | 60 | + |
5823eb2b JH |
61 | - 'no' - Show no untracked files. |
62 | - 'normal' - Shows untracked files and directories. | |
9e4b7ab6 | 63 | - 'all' - Also shows individual files in untracked directories. |
9e4b7ab6 | 64 | + |
5823eb2b JH |
65 | When `-u` option is not used, untracked files and directories are |
66 | shown (i.e. the same as specifying `normal`), to help you avoid | |
67 | forgetting to add newly created files. Because it takes extra work | |
68 | to find untracked files in the filesystem, this mode may take some | |
aeb6f8b3 NTND |
69 | time in a large working tree. |
70 | Consider enabling untracked cache and split index if supported (see | |
71 | `git update-index --untracked-cache` and `git update-index | |
72 | --split-index`), Otherwise you can use `no` to have `git status` | |
5823eb2b JH |
73 | return more quickly without showing untracked files. |
74 | + | |
4cc62606 CB |
75 | The default can be changed using the status.showUntrackedFiles |
76 | configuration variable documented in linkgit:git-config[1]. | |
9e4b7ab6 | 77 | |
46a958b3 JL |
78 | --ignore-submodules[=<when>]:: |
79 | Ignore changes to submodules when looking for changes. <when> can be | |
aee9c7d6 JL |
80 | either "none", "untracked", "dirty" or "all", which is the default. |
81 | Using "none" will consider the submodule modified when it either contains | |
82 | untracked or modified files or its HEAD differs from the commit recorded | |
83 | in the superproject and can be used to override any settings of the | |
302ad7a9 | 84 | 'ignore' option in linkgit:git-config[1] or linkgit:gitmodules[5]. When |
46a958b3 JL |
85 | "untracked" is used submodules are not considered dirty when they only |
86 | contain untracked content (but they are still scanned for modified | |
87 | content). Using "dirty" ignores all changes to the work tree of submodules, | |
88 | only changes to the commits stored in the superproject are shown (this was | |
89 | the behavior before 1.7.0). Using "all" hides all changes to submodules | |
90 | (and suppresses the output of submodule summaries when the config option | |
da0005b8 | 91 | `status.submoduleSummary` is set). |
46a958b3 | 92 | |
150b493a JH |
93 | --ignored:: |
94 | Show ignored files as well. | |
95 | ||
9e4b7ab6 | 96 | -z:: |
6f157871 JK |
97 | Terminate entries with NUL, instead of LF. This implies |
98 | the `--porcelain` output format if no other format is given. | |
2099bca9 | 99 | |
323d0530 NTND |
100 | --column[=<options>]:: |
101 | --no-column:: | |
102 | Display untracked files in columns. See configuration variable | |
103 | column.status for option syntax.`--column` and `--no-column` | |
104 | without options are equivalent to 'always' and 'never' | |
105 | respectively. | |
106 | ||
3f971fc4 JH |
107 | |
108 | OUTPUT | |
109 | ------ | |
110 | The output from this command is designed to be used as a commit | |
22d55aee | 111 | template comment. |
9e4b7ab6 | 112 | The default, long format, is designed to be human readable, |
043b5cd9 JK |
113 | verbose and descriptive. Its contents and format are subject to change |
114 | at any time. | |
3f971fc4 | 115 | |
2de9b711 | 116 | The paths mentioned in the output, unlike many other Git commands, are |
2099bca9 | 117 | made relative to the current directory if you are working in a |
46f721c8 JK |
118 | subdirectory (this is on purpose, to help cutting and pasting). See |
119 | the status.relativePaths config option below. | |
c7860507 | 120 | |
fc17df03 JK |
121 | Short Format |
122 | ~~~~~~~~~~~~ | |
123 | ||
043b5cd9 | 124 | In the short-format, the status of each path is shown as |
9e4b7ab6 JH |
125 | |
126 | XY PATH1 -> PATH2 | |
127 | ||
6cf378f0 | 128 | where `PATH1` is the path in the `HEAD`, and the " `-> PATH2`" part is |
9e4b7ab6 | 129 | shown only when `PATH1` corresponds to a different path in the |
7c45cee6 | 130 | index/worktree (i.e. the file is renamed). The `XY` is a two-letter |
e92e9cd3 ER |
131 | status code. |
132 | ||
6cf378f0 | 133 | The fields (including the `->`) are separated from each other by a |
e92e9cd3 ER |
134 | single space. If a filename contains whitespace or other nonprintable |
135 | characters, that field will be quoted in the manner of a C string | |
136 | literal: surrounded by ASCII double quote (34) characters, and with | |
137 | interior special characters backslash-escaped. | |
138 | ||
7c45cee6 | 139 | For paths with merge conflicts, `X` and `Y` show the modification |
e92e9cd3 ER |
140 | states of each side of the merge. For paths that do not have merge |
141 | conflicts, `X` shows the status of the index, and `Y` shows the status | |
142 | of the work tree. For untracked paths, `XY` are `??`. Other status | |
143 | codes can be interpreted as follows: | |
144 | ||
145 | * ' ' = unmodified | |
146 | * 'M' = modified | |
147 | * 'A' = added | |
148 | * 'D' = deleted | |
149 | * 'R' = renamed | |
150 | * 'C' = copied | |
151 | * 'U' = updated but unmerged | |
152 | ||
50cebdad JH |
153 | Ignored files are not listed, unless `--ignored` option is in effect, |
154 | in which case `XY` are `!!`. | |
9e4b7ab6 JH |
155 | |
156 | X Y Meaning | |
157 | ------------------------------------------------- | |
158 | [MD] not updated | |
159 | M [ MD] updated in index | |
160 | A [ MD] added to index | |
e92e9cd3 | 161 | D [ M] deleted from index |
9e4b7ab6 JH |
162 | R [ MD] renamed in index |
163 | C [ MD] copied in index | |
164 | [MARC] index and work tree matches | |
165 | [ MARC] M work tree changed since index | |
166 | [ MARC] D deleted in work tree | |
167 | ------------------------------------------------- | |
168 | D D unmerged, both deleted | |
169 | A U unmerged, added by us | |
170 | U D unmerged, deleted by them | |
171 | U A unmerged, added by them | |
172 | D U unmerged, deleted by us | |
173 | A A unmerged, both added | |
174 | U U unmerged, both modified | |
175 | ------------------------------------------------- | |
176 | ? ? untracked | |
150b493a | 177 | ! ! ignored |
9e4b7ab6 JH |
178 | ------------------------------------------------- |
179 | ||
46077fa5 MG |
180 | If -b is used the short-format status is preceded by a line |
181 | ||
182 | ## branchname tracking info | |
183 | ||
fc17df03 JK |
184 | Porcelain Format |
185 | ~~~~~~~~~~~~~~~~ | |
186 | ||
187 | The porcelain format is similar to the short format, but is guaranteed | |
2de9b711 | 188 | not to change in a backwards-incompatible way between Git versions or |
fc17df03 JK |
189 | based on user configuration. This makes it ideal for parsing by scripts. |
190 | The description of the short format above also describes the porcelain | |
191 | format, with a few exceptions: | |
192 | ||
193 | 1. The user's color.status configuration is not respected; color will | |
194 | always be off. | |
195 | ||
196 | 2. The user's status.relativePaths configuration is not respected; paths | |
197 | shown will always be relative to the repository root. | |
198 | ||
199 | There is also an alternate -z format recommended for machine parsing. In | |
e92e9cd3 | 200 | that format, the status field is the same, but some other things |
715e716a JK |
201 | change. First, the '\->' is omitted from rename entries and the field |
202 | order is reversed (e.g 'from \-> to' becomes 'to from'). Second, a NUL | |
e92e9cd3 ER |
203 | (ASCII 0) follows each filename, replacing space as a field separator |
204 | and the terminating newline (but a space still separates the status | |
205 | field from the first filename). Third, filenames containing special | |
206 | characters are not specially formatted; no quoting or | |
d4a6bf1f | 207 | backslash-escaping is performed. |
3f971fc4 | 208 | |
31fcd63c JH |
209 | CONFIGURATION |
210 | ------------- | |
211 | ||
212 | The command honors `color.status` (or `status.color` -- they | |
213 | mean the same thing and the latter is kept for backward | |
214 | compatibility) and `color.status.<slot>` configuration variables | |
215 | to colorize its output. | |
216 | ||
46f721c8 | 217 | If the config variable `status.relativePaths` is set to false, then all |
482a6c10 MG |
218 | paths shown are relative to the repository root, not to the current |
219 | directory. | |
46f721c8 | 220 | |
da0005b8 | 221 | If `status.submoduleSummary` is set to a non zero number or true (identical |
46b77a6b JK |
222 | to -1 or an unlimited number), the submodule summary will be enabled for |
223 | the long format and a summary of commits for modified submodules will be | |
bb58b696 JL |
224 | shown (see --summary-limit option of linkgit:git-submodule[1]). Please note |
225 | that the summary output from the status command will be suppressed for all | |
226 | submodules when `diff.ignoreSubmodules` is set to 'all' or only for those | |
227 | submodules where `submodule.<name>.ignore=all`. To also view the summary for | |
228 | ignored submodules you can either use the --ignore-submodules=dirty command | |
229 | line option or the 'git submodule summary' command, which shows a similar | |
230 | output but does not honor these settings. | |
ac8d5afc | 231 | |
56ae8df5 | 232 | SEE ALSO |
cedb8d5d | 233 | -------- |
5162e697 | 234 | linkgit:gitignore[5] |
31fcd63c | 235 | |
3f971fc4 JH |
236 | GIT |
237 | --- | |
9e1f0a85 | 238 | Part of the linkgit:git[1] suite |