]>
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 | -------- | |
9e4b7ab6 | 11 | 'git status' [<options>...] [--] [<pathspec>...] |
3f971fc4 JH |
12 | |
13 | DESCRIPTION | |
14 | ----------- | |
2099bca9 JK |
15 | Displays paths that have differences between the index file and the |
16 | current HEAD commit, paths that have differences between the working | |
17 | tree and the index file, and paths in the working tree that are not | |
5162e697 | 18 | tracked by git (and are not ignored by linkgit:gitignore[5]). The first |
2099bca9 | 19 | are what you _would_ commit by running `git commit`; the second and |
ba020ef5 | 20 | third are what you _could_ commit by running 'git-add' before running |
2099bca9 | 21 | `git commit`. |
3f971fc4 | 22 | |
9e4b7ab6 JH |
23 | OPTIONS |
24 | ------- | |
25 | ||
26 | -s:: | |
27 | --short:: | |
28 | Give the output in the short-format. | |
29 | ||
30 | -u[<mode>]:: | |
31 | --untracked-files[=<mode>]:: | |
32 | Show untracked files (Default: 'all'). | |
33 | + | |
34 | The mode parameter is optional, and is used to specify | |
35 | the handling of untracked files. The possible options are: | |
36 | + | |
37 | -- | |
38 | - 'no' - Show no untracked files | |
39 | - 'normal' - Shows untracked files and directories | |
40 | - 'all' - Also shows individual files in untracked directories. | |
41 | -- | |
42 | + | |
43 | See linkgit:git-config[1] for configuration variable | |
44 | used to change the default for when the option is not | |
45 | specified. | |
46 | ||
47 | -z:: | |
48 | Terminate entries with NUL, instead of LF. This implies `-s` | |
49 | (short status) output format. | |
2099bca9 | 50 | |
3f971fc4 JH |
51 | |
52 | OUTPUT | |
53 | ------ | |
54 | The output from this command is designed to be used as a commit | |
2099bca9 | 55 | template comment, and all the output lines are prefixed with '#'. |
9e4b7ab6 JH |
56 | The default, long format, is designed to be human readable, |
57 | verbose and descriptive. They are subject to change in any time. | |
3f971fc4 | 58 | |
c7860507 | 59 | The paths mentioned in the output, unlike many other git commands, are |
2099bca9 | 60 | made relative to the current directory if you are working in a |
46f721c8 JK |
61 | subdirectory (this is on purpose, to help cutting and pasting). See |
62 | the status.relativePaths config option below. | |
c7860507 | 63 | |
9e4b7ab6 JH |
64 | In short-format, the status of each path is shown as |
65 | ||
66 | XY PATH1 -> PATH2 | |
67 | ||
68 | where `PATH1` is the path in the `HEAD`, and ` -> PATH2` part is | |
69 | shown only when `PATH1` corresponds to a different path in the | |
70 | index/worktree (i.e. renamed). | |
71 | ||
72 | For unmerged entries, `X` shows the status of stage #2 (i.e. ours) and `Y` | |
73 | shows the status of stage #3 (i.e. theirs). | |
74 | ||
75 | For entries that do not have conflicts, `X` shows the status of the index, | |
76 | and `Y` shows the status of the work tree. For untracked paths, `XY` are | |
77 | `??`. | |
78 | ||
79 | X Y Meaning | |
80 | ------------------------------------------------- | |
81 | [MD] not updated | |
82 | M [ MD] updated in index | |
83 | A [ MD] added to index | |
84 | D [ MD] deleted from index | |
85 | R [ MD] renamed in index | |
86 | C [ MD] copied in index | |
87 | [MARC] index and work tree matches | |
88 | [ MARC] M work tree changed since index | |
89 | [ MARC] D deleted in work tree | |
90 | ------------------------------------------------- | |
91 | D D unmerged, both deleted | |
92 | A U unmerged, added by us | |
93 | U D unmerged, deleted by them | |
94 | U A unmerged, added by them | |
95 | D U unmerged, deleted by us | |
96 | A A unmerged, both added | |
97 | U U unmerged, both modified | |
98 | ------------------------------------------------- | |
99 | ? ? untracked | |
100 | ------------------------------------------------- | |
101 | ||
3f971fc4 | 102 | |
31fcd63c JH |
103 | CONFIGURATION |
104 | ------------- | |
105 | ||
106 | The command honors `color.status` (or `status.color` -- they | |
107 | mean the same thing and the latter is kept for backward | |
108 | compatibility) and `color.status.<slot>` configuration variables | |
109 | to colorize its output. | |
110 | ||
46f721c8 JK |
111 | If the config variable `status.relativePaths` is set to false, then all |
112 | paths shown are relative to the repository root, not to the current | |
113 | directory. | |
114 | ||
ac8d5afc PY |
115 | If `status.submodulesummary` is set to a non zero number or true (identical |
116 | to -1 or an unlimited number), the submodule summary will be enabled and a | |
117 | summary of commits for modified submodules will be shown (see --summary-limit | |
118 | option of linkgit:git-submodule[1]). | |
119 | ||
56ae8df5 | 120 | SEE ALSO |
cedb8d5d | 121 | -------- |
5162e697 | 122 | linkgit:gitignore[5] |
31fcd63c | 123 | |
3f971fc4 JH |
124 | Author |
125 | ------ | |
9e4b7ab6 | 126 | Written by Junio C Hamano <gitster@pobox.com>. |
3f971fc4 JH |
127 | |
128 | Documentation | |
129 | -------------- | |
130 | Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>. | |
131 | ||
132 | GIT | |
133 | --- | |
9e1f0a85 | 134 | Part of the linkgit:git[1] suite |