submodule: prevent backslash expantion in submodule names
[git/git.git] / Documentation / git-status.txt
1 git-status(1)
2 =============
3
4 NAME
5 ----
6 git-status - Show the working tree status
7
8
9 SYNOPSIS
10 --------
11 [verse]
12 'git status' [<options>...] [--] [<pathspec>...]
13
14 DESCRIPTION
15 -----------
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
19 tracked by Git (and are not ignored by linkgit:gitignore[5]). The first
20 are what you _would_ commit by running `git commit`; the second and
21 third are what you _could_ commit by running 'git add' before running
22 `git commit`.
23
24 OPTIONS
25 -------
26
27 -s::
28 --short::
29 Give the output in the short-format.
30
31 -b::
32 --branch::
33 Show the branch and tracking info even in short-format.
34
35 --porcelain[=<version>]::
36 Give the output in an easy-to-parse format for scripts.
37 This is similar to the short output, but will remain stable
38 across Git versions and regardless of user configuration. See
39 below for details.
40 +
41 The version parameter is used to specify the format version.
42 This is optional and defaults to the original version 'v1' format.
43
44 --long::
45 Give the output in the long-format. This is the default.
46
47 -v::
48 --verbose::
49 In addition to the names of files that have been changed, also
50 show the textual changes that are staged to be committed
51 (i.e., like the output of `git diff --cached`). If `-v` is specified
52 twice, then also show the changes in the working tree that
53 have not yet been staged (i.e., like the output of `git diff`).
54
55 -u[<mode>]::
56 --untracked-files[=<mode>]::
57 Show untracked files.
58 +
59 The mode parameter is used to specify the handling of untracked files.
60 It is optional: it defaults to 'all', and if specified, it must be
61 stuck to the option (e.g. `-uno`, but not `-u no`).
62 +
63 The possible options are:
64 +
65 - 'no' - Show no untracked files.
66 - 'normal' - Shows untracked files and directories.
67 - 'all' - Also shows individual files in untracked directories.
68 +
69 When `-u` option is not used, untracked files and directories are
70 shown (i.e. the same as specifying `normal`), to help you avoid
71 forgetting to add newly created files. Because it takes extra work
72 to find untracked files in the filesystem, this mode may take some
73 time in a large working tree.
74 Consider enabling untracked cache and split index if supported (see
75 `git update-index --untracked-cache` and `git update-index
76 --split-index`), Otherwise you can use `no` to have `git status`
77 return more quickly without showing untracked files.
78 +
79 The default can be changed using the status.showUntrackedFiles
80 configuration variable documented in linkgit:git-config[1].
81
82 --ignore-submodules[=<when>]::
83 Ignore changes to submodules when looking for changes. <when> can be
84 either "none", "untracked", "dirty" or "all", which is the default.
85 Using "none" will consider the submodule modified when it either contains
86 untracked or modified files or its HEAD differs from the commit recorded
87 in the superproject and can be used to override any settings of the
88 'ignore' option in linkgit:git-config[1] or linkgit:gitmodules[5]. When
89 "untracked" is used submodules are not considered dirty when they only
90 contain untracked content (but they are still scanned for modified
91 content). Using "dirty" ignores all changes to the work tree of submodules,
92 only changes to the commits stored in the superproject are shown (this was
93 the behavior before 1.7.0). Using "all" hides all changes to submodules
94 (and suppresses the output of submodule summaries when the config option
95 `status.submoduleSummary` is set).
96
97 --ignored::
98 Show ignored files as well.
99
100 -z::
101 Terminate entries with NUL, instead of LF. This implies
102 the `--porcelain=v1` output format if no other format is given.
103
104 --column[=<options>]::
105 --no-column::
106 Display untracked files in columns. See configuration variable
107 column.status for option syntax.`--column` and `--no-column`
108 without options are equivalent to 'always' and 'never'
109 respectively.
110
111
112 OUTPUT
113 ------
114 The output from this command is designed to be used as a commit
115 template comment.
116 The default, long format, is designed to be human readable,
117 verbose and descriptive. Its contents and format are subject to change
118 at any time.
119
120 The paths mentioned in the output, unlike many other Git commands, are
121 made relative to the current directory if you are working in a
122 subdirectory (this is on purpose, to help cutting and pasting). See
123 the status.relativePaths config option below.
124
125 Short Format
126 ~~~~~~~~~~~~
127
128 In the short-format, the status of each path is shown as
129
130 XY PATH1 -> PATH2
131
132 where `PATH1` is the path in the `HEAD`, and the " `-> PATH2`" part is
133 shown only when `PATH1` corresponds to a different path in the
134 index/worktree (i.e. the file is renamed). The `XY` is a two-letter
135 status code.
136
137 The fields (including the `->`) are separated from each other by a
138 single space. If a filename contains whitespace or other nonprintable
139 characters, that field will be quoted in the manner of a C string
140 literal: surrounded by ASCII double quote (34) characters, and with
141 interior special characters backslash-escaped.
142
143 For paths with merge conflicts, `X` and `Y` show the modification
144 states of each side of the merge. For paths that do not have merge
145 conflicts, `X` shows the status of the index, and `Y` shows the status
146 of the work tree. For untracked paths, `XY` are `??`. Other status
147 codes can be interpreted as follows:
148
149 * ' ' = unmodified
150 * 'M' = modified
151 * 'A' = added
152 * 'D' = deleted
153 * 'R' = renamed
154 * 'C' = copied
155 * 'U' = updated but unmerged
156
157 Ignored files are not listed, unless `--ignored` option is in effect,
158 in which case `XY` are `!!`.
159
160 X Y Meaning
161 -------------------------------------------------
162 [MD] not updated
163 M [ MD] updated in index
164 A [ MD] added to index
165 D [ M] deleted from index
166 R [ MD] renamed in index
167 C [ MD] copied in index
168 [MARC] index and work tree matches
169 [ MARC] M work tree changed since index
170 [ MARC] D deleted in work tree
171 -------------------------------------------------
172 D D unmerged, both deleted
173 A U unmerged, added by us
174 U D unmerged, deleted by them
175 U A unmerged, added by them
176 D U unmerged, deleted by us
177 A A unmerged, both added
178 U U unmerged, both modified
179 -------------------------------------------------
180 ? ? untracked
181 ! ! ignored
182 -------------------------------------------------
183
184 If -b is used the short-format status is preceded by a line
185
186 ## branchname tracking info
187
188 Porcelain Format Version 1
189 ~~~~~~~~~~~~~~~~~~~~~~~~~~
190
191 Version 1 porcelain format is similar to the short format, but is guaranteed
192 not to change in a backwards-incompatible way between Git versions or
193 based on user configuration. This makes it ideal for parsing by scripts.
194 The description of the short format above also describes the porcelain
195 format, with a few exceptions:
196
197 1. The user's color.status configuration is not respected; color will
198 always be off.
199
200 2. The user's status.relativePaths configuration is not respected; paths
201 shown will always be relative to the repository root.
202
203 There is also an alternate -z format recommended for machine parsing. In
204 that format, the status field is the same, but some other things
205 change. First, the '\->' is omitted from rename entries and the field
206 order is reversed (e.g 'from \-> to' becomes 'to from'). Second, a NUL
207 (ASCII 0) follows each filename, replacing space as a field separator
208 and the terminating newline (but a space still separates the status
209 field from the first filename). Third, filenames containing special
210 characters are not specially formatted; no quoting or
211 backslash-escaping is performed.
212
213 Porcelain Format Version 2
214 ~~~~~~~~~~~~~~~~~~~~~~~~~~
215
216 Version 2 format adds more detailed information about the state of
217 the worktree and changed items. Version 2 also defines an extensible
218 set of easy to parse optional headers.
219
220 Header lines start with "#" and are added in response to specific
221 command line arguments. Parsers should ignore headers they
222 don't recognize.
223
224 ### Branch Headers
225
226 If `--branch` is given, a series of header lines are printed with
227 information about the current branch.
228
229 Line Notes
230 ------------------------------------------------------------
231 # branch.oid <commit> | (initial) Current commit.
232 # branch.head <branch> | (detached) Current branch.
233 # branch.upstream <upstream_branch> If upstream is set.
234 # branch.ab +<ahead> -<behind> If upstream is set and
235 the commit is present.
236 ------------------------------------------------------------
237
238 ### Changed Tracked Entries
239
240 Following the headers, a series of lines are printed for tracked
241 entries. One of three different line formats may be used to describe
242 an entry depending on the type of change. Tracked entries are printed
243 in an undefined order; parsers should allow for a mixture of the 3
244 line types in any order.
245
246 Ordinary changed entries have the following format:
247
248 1 <XY> <sub> <mH> <mI> <mW> <hH> <hI> <path>
249
250 Renamed or copied entries have the following format:
251
252 2 <XY> <sub> <mH> <mI> <mW> <hH> <hI> <X><score> <path><sep><origPath>
253
254 Field Meaning
255 --------------------------------------------------------
256 <XY> A 2 character field containing the staged and
257 unstaged XY values described in the short format,
258 with unchanged indicated by a "." rather than
259 a space.
260 <sub> A 4 character field describing the submodule state.
261 "N..." when the entry is not a submodule.
262 "S<c><m><u>" when the entry is a submodule.
263 <c> is "C" if the commit changed; otherwise ".".
264 <m> is "M" if it has tracked changes; otherwise ".".
265 <u> is "U" if there are untracked changes; otherwise ".".
266 <mH> The octal file mode in HEAD.
267 <mI> The octal file mode in the index.
268 <mW> The octal file mode in the worktree.
269 <hH> The object name in HEAD.
270 <hI> The object name in the index.
271 <X><score> The rename or copy score (denoting the percentage
272 of similarity between the source and target of the
273 move or copy). For example "R100" or "C75".
274 <path> The pathname. In a renamed/copied entry, this
275 is the path in the index and in the working tree.
276 <sep> When the `-z` option is used, the 2 pathnames are separated
277 with a NUL (ASCII 0x00) byte; otherwise, a tab (ASCII 0x09)
278 byte separates them.
279 <origPath> The pathname in the commit at HEAD. This is only
280 present in a renamed/copied entry, and tells
281 where the renamed/copied contents came from.
282 --------------------------------------------------------
283
284 Unmerged entries have the following format; the first character is
285 a "u" to distinguish from ordinary changed entries.
286
287 u <xy> <sub> <m1> <m2> <m3> <mW> <h1> <h2> <h3> <path>
288
289 Field Meaning
290 --------------------------------------------------------
291 <XY> A 2 character field describing the conflict type
292 as described in the short format.
293 <sub> A 4 character field describing the submodule state
294 as described above.
295 <m1> The octal file mode in stage 1.
296 <m2> The octal file mode in stage 2.
297 <m3> The octal file mode in stage 3.
298 <mW> The octal file mode in the worktree.
299 <h1> The object name in stage 1.
300 <h2> The object name in stage 2.
301 <h3> The object name in stage 3.
302 <path> The pathname.
303 --------------------------------------------------------
304
305 ### Other Items
306
307 Following the tracked entries (and if requested), a series of
308 lines will be printed for untracked and then ignored items
309 found in the worktree.
310
311 Untracked items have the following format:
312
313 ? <path>
314
315 Ignored items have the following format:
316
317 ! <path>
318
319 ### Pathname Format Notes and -z
320
321 When the `-z` option is given, pathnames are printed as is and
322 without any quoting and lines are terminated with a NUL (ASCII 0x00)
323 byte.
324
325 Without the `-z` option, pathnames with "unusual" characters are
326 quoted as explained for the configuration variable `core.quotePath`
327 (see linkgit:git-config[1]).
328
329
330 CONFIGURATION
331 -------------
332
333 The command honors `color.status` (or `status.color` -- they
334 mean the same thing and the latter is kept for backward
335 compatibility) and `color.status.<slot>` configuration variables
336 to colorize its output.
337
338 If the config variable `status.relativePaths` is set to false, then all
339 paths shown are relative to the repository root, not to the current
340 directory.
341
342 If `status.submoduleSummary` is set to a non zero number or true (identical
343 to -1 or an unlimited number), the submodule summary will be enabled for
344 the long format and a summary of commits for modified submodules will be
345 shown (see --summary-limit option of linkgit:git-submodule[1]). Please note
346 that the summary output from the status command will be suppressed for all
347 submodules when `diff.ignoreSubmodules` is set to 'all' or only for those
348 submodules where `submodule.<name>.ignore=all`. To also view the summary for
349 ignored submodules you can either use the --ignore-submodules=dirty command
350 line option or the 'git submodule summary' command, which shows a similar
351 output but does not honor these settings.
352
353 SEE ALSO
354 --------
355 linkgit:gitignore[5]
356
357 GIT
358 ---
359 Part of the linkgit:git[1] suite