Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 213 lines (174 sloc) 7.585 kB
1a4e841 Autogenerated HTML docs for 36de72aa9dc3b7daf8cf2770c840f39bb0d2ae70
Junio C Hamano authored
1 git-status(1)
2 =============
3
4 NAME
5 ----
7c73c66 Autogenerated HTML docs for v1.5.0-rc1-g72fe
Junio C Hamano authored
6 git-status - Show the working tree status
1a4e841 Autogenerated HTML docs for 36de72aa9dc3b7daf8cf2770c840f39bb0d2ae70
Junio C Hamano authored
7
8
9 SYNOPSIS
10 --------
15567bc Autogenerated HTML docs for v1.7.6-345-g5c2f8
Junio C Hamano authored
11 [verse]
a0fae26 Autogenerated HTML docs for v1.6.6-60-gc2ff1
Junio C Hamano authored
12 'git status' [<options>...] [--] [<pathspec>...]
1a4e841 Autogenerated HTML docs for 36de72aa9dc3b7daf8cf2770c840f39bb0d2ae70
Junio C Hamano authored
13
14 DESCRIPTION
15 -----------
942b35e Autogenerated HTML docs for v1.5.3.7-1141-g4eb3
Junio C Hamano authored
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
35738e8 Autogenerated HTML docs for v1.5.4-rc2-60-gb2e62
Junio C Hamano authored
19 tracked by git (and are not ignored by linkgit:gitignore[5]). The first
942b35e Autogenerated HTML docs for v1.5.3.7-1141-g4eb3
Junio C Hamano authored
20 are what you _would_ commit by running `git commit`; the second and
1aa40d2 Autogenerated HTML docs for v1.6.6.1-383-g5a9f
Junio C Hamano authored
21 third are what you _could_ commit by running 'git add' before running
942b35e Autogenerated HTML docs for v1.5.3.7-1141-g4eb3
Junio C Hamano authored
22 `git commit`.
1a4e841 Autogenerated HTML docs for 36de72aa9dc3b7daf8cf2770c840f39bb0d2ae70
Junio C Hamano authored
23
a0fae26 Autogenerated HTML docs for v1.6.6-60-gc2ff1
Junio C Hamano authored
24 OPTIONS
25 -------
26
27 -s::
28 --short::
29 Give the output in the short-format.
30
f5de4cf Autogenerated HTML docs for v1.7.1-422-g049e9
Junio C Hamano authored
31 -b::
32 --branch::
33 Show the branch and tracking info even in short-format.
34
a0fae26 Autogenerated HTML docs for v1.6.6-60-gc2ff1
Junio C Hamano authored
35 --porcelain::
ef5a2f9 Autogenerated HTML docs for v1.7.5.3-485-g090a1
Junio C Hamano authored
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.
a0fae26 Autogenerated HTML docs for v1.6.6-60-gc2ff1
Junio C Hamano authored
40
41 -u[<mode>]::
42 --untracked-files[=<mode>]::
36a4dbc Autogenerated HTML docs for v1.7.4.1-55-gdca3d
Junio C Hamano authored
43 Show untracked files.
a0fae26 Autogenerated HTML docs for v1.6.6-60-gc2ff1
Junio C Hamano authored
44 +
36a4dbc Autogenerated HTML docs for v1.7.4.1-55-gdca3d
Junio C Hamano authored
45 The mode parameter is optional (defaults to 'all'), and is used to
46 specify the handling of untracked files; when -u is not used, the
47 default is 'normal', i.e. show untracked files and directories.
48 +
49 The possible options are:
a0fae26 Autogenerated HTML docs for v1.6.6-60-gc2ff1
Junio C Hamano authored
50 +
51 - 'no' - Show no untracked files
52 - 'normal' - Shows untracked files and directories
53 - 'all' - Also shows individual files in untracked directories.
54 +
36a4dbc Autogenerated HTML docs for v1.7.4.1-55-gdca3d
Junio C Hamano authored
55 The default can be changed using the status.showUntrackedFiles
56 configuration variable documented in linkgit:git-config[1].
a0fae26 Autogenerated HTML docs for v1.6.6-60-gc2ff1
Junio C Hamano authored
57
7d44952 Autogenerated HTML docs for v1.7.2-rc1
Junio C Hamano authored
58 --ignore-submodules[=<when>]::
59 Ignore changes to submodules when looking for changes. <when> can be
619596a Autogenerated HTML docs for v1.7.2.1-158-gbd3a97
Junio C Hamano authored
60 either "none", "untracked", "dirty" or "all", which is the default.
61 Using "none" will consider the submodule modified when it either contains
62 untracked or modified files or its HEAD differs from the commit recorded
63 in the superproject and can be used to override any settings of the
64 'ignore' option in linkgit:git-config[1] or linkgit:gitmodules[5]. When
7d44952 Autogenerated HTML docs for v1.7.2-rc1
Junio C Hamano authored
65 "untracked" is used submodules are not considered dirty when they only
66 contain untracked content (but they are still scanned for modified
67 content). Using "dirty" ignores all changes to the work tree of submodules,
68 only changes to the commits stored in the superproject are shown (this was
69 the behavior before 1.7.0). Using "all" hides all changes to submodules
70 (and suppresses the output of submodule summaries when the config option
71 `status.submodulesummary` is set).
72
4c4b012 Autogenerated HTML docs for v1.7.6-49-g033c2
Junio C Hamano authored
73 --ignored::
74 Show ignored files as well.
75
a0fae26 Autogenerated HTML docs for v1.6.6-60-gc2ff1
Junio C Hamano authored
76 -z::
77 Terminate entries with NUL, instead of LF. This implies
78 the `--porcelain` output format if no other format is given.
942b35e Autogenerated HTML docs for v1.5.3.7-1141-g4eb3
Junio C Hamano authored
79
22700fb @gitster Autogenerated HTML docs for v1.7.10.1-456-g16798
authored
80 --column[=<options>]::
81 --no-column::
82 Display untracked files in columns. See configuration variable
83 column.status for option syntax.`--column` and `--no-column`
84 without options are equivalent to 'always' and 'never'
85 respectively.
86
1a4e841 Autogenerated HTML docs for 36de72aa9dc3b7daf8cf2770c840f39bb0d2ae70
Junio C Hamano authored
87
88 OUTPUT
89 ------
90 The output from this command is designed to be used as a commit
942b35e Autogenerated HTML docs for v1.5.3.7-1141-g4eb3
Junio C Hamano authored
91 template comment, and all the output lines are prefixed with '#'.
a0fae26 Autogenerated HTML docs for v1.6.6-60-gc2ff1
Junio C Hamano authored
92 The default, long format, is designed to be human readable,
ef5a2f9 Autogenerated HTML docs for v1.7.5.3-485-g090a1
Junio C Hamano authored
93 verbose and descriptive. Its contents and format are subject to change
94 at any time.
1a4e841 Autogenerated HTML docs for 36de72aa9dc3b7daf8cf2770c840f39bb0d2ae70
Junio C Hamano authored
95
00b8b63 Autogenerated HTML docs for v1.5.3.7-1112-g9758e
Junio C Hamano authored
96 The paths mentioned in the output, unlike many other git commands, are
942b35e Autogenerated HTML docs for v1.5.3.7-1141-g4eb3
Junio C Hamano authored
97 made relative to the current directory if you are working in a
98 subdirectory (this is on purpose, to help cutting and pasting). See
99 the status.relativePaths config option below.
00b8b63 Autogenerated HTML docs for v1.5.3.7-1112-g9758e
Junio C Hamano authored
100
ef5a2f9 Autogenerated HTML docs for v1.7.5.3-485-g090a1
Junio C Hamano authored
101 Short Format
102 ~~~~~~~~~~~~
103
104 In the short-format, the status of each path is shown as
a0fae26 Autogenerated HTML docs for v1.6.6-60-gc2ff1
Junio C Hamano authored
105
106 XY PATH1 -> PATH2
107
b76a686 @gitster Autogenerated HTML docs for v1.7.10.1-433-g34875
authored
108 where `PATH1` is the path in the `HEAD`, and the " `-> PATH2`" part is
a0fae26 Autogenerated HTML docs for v1.6.6-60-gc2ff1
Junio C Hamano authored
109 shown only when `PATH1` corresponds to a different path in the
fc5d735 Autogenerated HTML docs for v1.7.1
Junio C Hamano authored
110 index/worktree (i.e. the file is renamed). The 'XY' is a two-letter
111 status code.
112
b76a686 @gitster Autogenerated HTML docs for v1.7.10.1-433-g34875
authored
113 The fields (including the `->`) are separated from each other by a
fc5d735 Autogenerated HTML docs for v1.7.1
Junio C Hamano authored
114 single space. If a filename contains whitespace or other nonprintable
115 characters, that field will be quoted in the manner of a C string
116 literal: surrounded by ASCII double quote (34) characters, and with
117 interior special characters backslash-escaped.
118
119 For paths with merge conflicts, `X` and 'Y' show the modification
120 states of each side of the merge. For paths that do not have merge
121 conflicts, `X` shows the status of the index, and `Y` shows the status
122 of the work tree. For untracked paths, `XY` are `??`. Other status
123 codes can be interpreted as follows:
124
125 * ' ' = unmodified
126 * 'M' = modified
127 * 'A' = added
128 * 'D' = deleted
129 * 'R' = renamed
130 * 'C' = copied
131 * 'U' = updated but unmerged
132
4c4b012 Autogenerated HTML docs for v1.7.6-49-g033c2
Junio C Hamano authored
133 Ignored files are not listed, unless `--ignored` option is in effect,
134 in which case `XY` are `!!`.
a0fae26 Autogenerated HTML docs for v1.6.6-60-gc2ff1
Junio C Hamano authored
135
136 X Y Meaning
137 -------------------------------------------------
138 [MD] not updated
139 M [ MD] updated in index
140 A [ MD] added to index
fc5d735 Autogenerated HTML docs for v1.7.1
Junio C Hamano authored
141 D [ M] deleted from index
a0fae26 Autogenerated HTML docs for v1.6.6-60-gc2ff1
Junio C Hamano authored
142 R [ MD] renamed in index
143 C [ MD] copied in index
144 [MARC] index and work tree matches
145 [ MARC] M work tree changed since index
146 [ MARC] D deleted in work tree
147 -------------------------------------------------
148 D D unmerged, both deleted
149 A U unmerged, added by us
150 U D unmerged, deleted by them
151 U A unmerged, added by them
152 D U unmerged, deleted by us
153 A A unmerged, both added
154 U U unmerged, both modified
155 -------------------------------------------------
156 ? ? untracked
4c4b012 Autogenerated HTML docs for v1.7.6-49-g033c2
Junio C Hamano authored
157 ! ! ignored
a0fae26 Autogenerated HTML docs for v1.6.6-60-gc2ff1
Junio C Hamano authored
158 -------------------------------------------------
159
f5de4cf Autogenerated HTML docs for v1.7.1-422-g049e9
Junio C Hamano authored
160 If -b is used the short-format status is preceded by a line
161
162 ## branchname tracking info
163
ef5a2f9 Autogenerated HTML docs for v1.7.5.3-485-g090a1
Junio C Hamano authored
164 Porcelain Format
165 ~~~~~~~~~~~~~~~~
166
167 The porcelain format is similar to the short format, but is guaranteed
168 not to change in a backwards-incompatible way between git versions or
169 based on user configuration. This makes it ideal for parsing by scripts.
170 The description of the short format above also describes the porcelain
171 format, with a few exceptions:
172
173 1. The user's color.status configuration is not respected; color will
174 always be off.
175
176 2. The user's status.relativePaths configuration is not respected; paths
177 shown will always be relative to the repository root.
178
179 There is also an alternate -z format recommended for machine parsing. In
fc5d735 Autogenerated HTML docs for v1.7.1
Junio C Hamano authored
180 that format, the status field is the same, but some other things
ef5a2f9 Autogenerated HTML docs for v1.7.5.3-485-g090a1
Junio C Hamano authored
181 change. First, the '\->' is omitted from rename entries and the field
182 order is reversed (e.g 'from \-> to' becomes 'to from'). Second, a NUL
fc5d735 Autogenerated HTML docs for v1.7.1
Junio C Hamano authored
183 (ASCII 0) follows each filename, replacing space as a field separator
184 and the terminating newline (but a space still separates the status
185 field from the first filename). Third, filenames containing special
186 characters are not specially formatted; no quoting or
bcdb12e @gitster Autogenerated HTML docs for v1.7.10.1-553-gb7fbc
authored
187 backslash-escaping is performed.
1a4e841 Autogenerated HTML docs for 36de72aa9dc3b7daf8cf2770c840f39bb0d2ae70
Junio C Hamano authored
188
f9771f6 Autogenerated HTML docs for v1.5.0-rc1-g23bf
Junio C Hamano authored
189 CONFIGURATION
190 -------------
191
192 The command honors `color.status` (or `status.color` -- they
193 mean the same thing and the latter is kept for backward
194 compatibility) and `color.status.<slot>` configuration variables
195 to colorize its output.
196
942b35e Autogenerated HTML docs for v1.5.3.7-1141-g4eb3
Junio C Hamano authored
197 If the config variable `status.relativePaths` is set to false, then all
198 paths shown are relative to the repository root, not to the current
199 directory.
200
e3ddb5b Autogenerated HTML docs for v1.5.5.1-57-g5909c
Junio C Hamano authored
201 If `status.submodulesummary` is set to a non zero number or true (identical
a0fae26 Autogenerated HTML docs for v1.6.6-60-gc2ff1
Junio C Hamano authored
202 to -1 or an unlimited number), the submodule summary will be enabled for
203 the long format and a summary of commits for modified submodules will be
204 shown (see --summary-limit option of linkgit:git-submodule[1]).
e3ddb5b Autogenerated HTML docs for v1.5.5.1-57-g5909c
Junio C Hamano authored
205
9049d91 Autogenerated HTML docs for v1.5.6-rc0-46-gd2b3
Junio C Hamano authored
206 SEE ALSO
679d22d Autogenerated HTML docs for v1.5.2-167-g4bc70
Junio C Hamano authored
207 --------
35738e8 Autogenerated HTML docs for v1.5.4-rc2-60-gb2e62
Junio C Hamano authored
208 linkgit:gitignore[5]
f9771f6 Autogenerated HTML docs for v1.5.0-rc1-g23bf
Junio C Hamano authored
209
1a4e841 Autogenerated HTML docs for 36de72aa9dc3b7daf8cf2770c840f39bb0d2ae70
Junio C Hamano authored
210 GIT
211 ---
f7c042d Autogenerated HTML docs for v1.5.6-rc1-21-g03300
Junio C Hamano authored
212 Part of the linkgit:git[1] suite
Something went wrong with that request. Please try again.