]>
Commit | Line | Data |
---|---|---|
09ccdb63 NS |
1 | git-stash(1) |
2 | ============ | |
3 | ||
4 | NAME | |
5 | ---- | |
6 | git-stash - Stash the changes in a dirty working directory away | |
7 | ||
8 | SYNOPSIS | |
9 | -------- | |
10 | [verse] | |
b1889c36 JN |
11 | 'git stash' (list | show [<stash>] | apply [<stash>] | clear | drop [<stash>] | pop [<stash>]) |
12 | 'git stash' [save [<message>]] | |
09ccdb63 NS |
13 | |
14 | DESCRIPTION | |
15 | ----------- | |
16 | ||
b1889c36 | 17 | Use 'git stash' when you want to record the current state of the |
09ccdb63 NS |
18 | working directory and the index, but want to go back to a clean |
19 | working directory. The command saves your local modifications away | |
20 | and reverts the working directory to match the `HEAD` commit. | |
21 | ||
22 | The modifications stashed away by this command can be listed with | |
483bc4f0 JN |
23 | `git stash list`, inspected with `git stash show`, and restored |
24 | (potentially on top of a different commit) with `git stash apply`. | |
25 | Calling `git stash` without any arguments is equivalent to `git stash save`. | |
26 | A stash is by default listed as "WIP on 'branchname' ...", but | |
ec96e0f6 NS |
27 | you can give a more descriptive message on the command line when |
28 | you create one. | |
09ccdb63 NS |
29 | |
30 | The latest stash you created is stored in `$GIT_DIR/refs/stash`; older | |
9488e875 | 31 | stashes are found in the reflog of this reference and can be named using |
e2c6de1c SH |
32 | the usual reflog syntax (e.g. `stash@\{0}` is the most recently |
33 | created stash, `stash@\{1}` is the one before it, `stash@\{2.hours.ago}` | |
9488e875 | 34 | is also possible). |
09ccdb63 NS |
35 | |
36 | OPTIONS | |
37 | ------- | |
38 | ||
7bedebca | 39 | save [--keep-index] [<message>]:: |
09ccdb63 | 40 | |
b1889c36 | 41 | Save your local modifications to a new 'stash', and run `git reset |
fcb10a96 | 42 | --hard` to revert them. This is the default action when no |
71bda8b9 JA |
43 | subcommand is given. The <message> part is optional and gives |
44 | the description along with the stashed state. | |
7bedebca SG |
45 | + |
46 | If the `--keep-index` option is used, all changes already added to the | |
47 | index are left intact. | |
09ccdb63 | 48 | |
fbd538c2 | 49 | list [<options>]:: |
09ccdb63 NS |
50 | |
51 | List the stashes that you currently have. Each 'stash' is listed | |
36717575 | 52 | with its name (e.g. `stash@\{0}` is the latest stash, `stash@\{1}` is |
9488e875 | 53 | the one before, etc.), the name of the branch that was current when the |
09ccdb63 NS |
54 | stash was made, and a short description of the commit the stash was |
55 | based on. | |
56 | + | |
57 | ---------------------------------------------------------------- | |
ec96e0f6 NS |
58 | stash@{0}: WIP on submit: 6ebd0e2... Update git-stash documentation |
59 | stash@{1}: On master: 9cc0589... Add git-stash | |
09ccdb63 | 60 | ---------------------------------------------------------------- |
fbd538c2 | 61 | + |
483bc4f0 JN |
62 | The command takes options applicable to the `git-log` |
63 | command to control what is shown and how. See linkgit:git-log[1]. | |
09ccdb63 NS |
64 | |
65 | show [<stash>]:: | |
66 | ||
06ada152 | 67 | Show the changes recorded in the stash as a diff between the |
9488e875 JH |
68 | stashed state and its original parent. When no `<stash>` is given, |
69 | shows the latest one. By default, the command shows the diffstat, but | |
b1889c36 | 70 | it will accept any format known to `git-diff` (e.g., `git stash show |
e2c6de1c | 71 | -p stash@\{1}` to view the second most recent stash in patch form). |
09ccdb63 | 72 | |
0bdcac56 | 73 | apply [--index] [<stash>]:: |
09ccdb63 | 74 | |
9488e875 | 75 | Restore the changes recorded in the stash on top of the current |
09ccdb63 | 76 | working tree state. When no `<stash>` is given, applies the latest |
9488e875 JH |
77 | one. The working directory must match the index. |
78 | + | |
79 | This operation can fail with conflicts; you need to resolve them | |
80 | by hand in the working tree. | |
0bdcac56 MV |
81 | + |
82 | If the `--index` option is used, then tries to reinstate not only the working | |
83 | tree's changes, but also the index's ones. However, this can fail, when you | |
84 | have conflicts (which are stored in the index, where you therefore can no | |
85 | longer apply the changes as they were originally). | |
09ccdb63 NS |
86 | |
87 | clear:: | |
9488e875 JH |
88 | Remove all the stashed states. Note that those states will then |
89 | be subject to pruning, and may be difficult or impossible to recover. | |
09ccdb63 | 90 | |
e25d5f9c BC |
91 | drop [<stash>]:: |
92 | ||
93 | Remove a single stashed state from the stash list. When no `<stash>` | |
94 | is given, it removes the latest one. i.e. `stash@\{0}` | |
95 | ||
bd56ff54 BC |
96 | pop [<stash>]:: |
97 | ||
98 | Remove a single stashed state from the stash list and apply on top | |
99 | of the current working tree state. When no `<stash>` is given, | |
100 | `stash@\{0}` is assumed. See also `apply`. | |
101 | ||
09ccdb63 NS |
102 | |
103 | DISCUSSION | |
104 | ---------- | |
105 | ||
106 | A stash is represented as a commit whose tree records the state of the | |
107 | working directory, and its first parent is the commit at `HEAD` when | |
108 | the stash was created. The tree of the second parent records the | |
109 | state of the index when the stash is made, and it is made a child of | |
110 | the `HEAD` commit. The ancestry graph looks like this: | |
111 | ||
112 | .----W | |
113 | / / | |
114fd812 | 114 | -----H----I |
09ccdb63 NS |
115 | |
116 | where `H` is the `HEAD` commit, `I` is a commit that records the state | |
117 | of the index, and `W` is a commit that records the state of the working | |
118 | tree. | |
119 | ||
120 | ||
121 | EXAMPLES | |
122 | -------- | |
123 | ||
124 | Pulling into a dirty tree:: | |
125 | ||
126 | When you are in the middle of something, you learn that there are | |
9488e875 JH |
127 | upstream changes that are possibly relevant to what you are |
128 | doing. When your local changes do not conflict with the changes in | |
09ccdb63 NS |
129 | the upstream, a simple `git pull` will let you move forward. |
130 | + | |
131 | However, there are cases in which your local changes do conflict with | |
132 | the upstream changes, and `git pull` refuses to overwrite your | |
9488e875 | 133 | changes. In such a case, you can stash your changes away, |
09ccdb63 NS |
134 | perform a pull, and then unstash, like this: |
135 | + | |
136 | ---------------------------------------------------------------- | |
137 | $ git pull | |
138 | ... | |
139 | file foobar not up to date, cannot merge. | |
140 | $ git stash | |
141 | $ git pull | |
142 | $ git stash apply | |
143 | ---------------------------------------------------------------- | |
144 | ||
145 | Interrupted workflow:: | |
146 | ||
147 | When you are in the middle of something, your boss comes in and | |
9488e875 | 148 | demands that you fix something immediately. Traditionally, you would |
09ccdb63 | 149 | make a commit to a temporary branch to store your changes away, and |
9488e875 | 150 | return to your original branch to make the emergency fix, like this: |
09ccdb63 NS |
151 | + |
152 | ---------------------------------------------------------------- | |
153 | ... hack hack hack ... | |
154 | $ git checkout -b my_wip | |
155 | $ git commit -a -m "WIP" | |
156 | $ git checkout master | |
157 | $ edit emergency fix | |
158 | $ git commit -a -m "Fix in a hurry" | |
159 | $ git checkout my_wip | |
160 | $ git reset --soft HEAD^ | |
161 | ... continue hacking ... | |
162 | ---------------------------------------------------------------- | |
163 | + | |
164 | You can use `git-stash` to simplify the above, like this: | |
165 | + | |
166 | ---------------------------------------------------------------- | |
167 | ... hack hack hack ... | |
168 | $ git stash | |
169 | $ edit emergency fix | |
170 | $ git commit -a -m "Fix in a hurry" | |
171 | $ git stash apply | |
172 | ... continue hacking ... | |
173 | ---------------------------------------------------------------- | |
174 | ||
7bedebca SG |
175 | Testing partial commits:: |
176 | ||
177 | You can use `git stash save --keep-index` when you want to make two or | |
178 | more commits out of the changes in the work tree, and you want to test | |
179 | each change before committing: | |
180 | + | |
181 | ---------------------------------------------------------------- | |
182 | ... hack hack hack ... | |
183 | $ git add --patch foo | |
184 | $ git stash save --keep-index | |
185 | $ build && run tests | |
186 | $ git commit -m 'First part' | |
187 | $ git stash apply | |
188 | $ build && run tests | |
189 | $ git commit -a -m 'Second part' | |
190 | ---------------------------------------------------------------- | |
191 | ||
09ccdb63 NS |
192 | SEE ALSO |
193 | -------- | |
5162e697 DM |
194 | linkgit:git-checkout[1], |
195 | linkgit:git-commit[1], | |
196 | linkgit:git-reflog[1], | |
197 | linkgit:git-reset[1] | |
09ccdb63 NS |
198 | |
199 | AUTHOR | |
200 | ------ | |
201 | Written by Nanako Shiraishi <nanako3@bluebottle.com> | |
202 | ||
203 | GIT | |
204 | --- | |
9e1f0a85 | 205 | Part of the linkgit:git[1] suite |