]>
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] | |
a5ab00c5 | 11 | 'git stash' list [<options>] |
fcdd0e92 SB |
12 | 'git stash' show [<stash>] |
13 | 'git stash' drop [-q|--quiet] [<stash>] | |
14 | 'git stash' ( pop | apply ) [--index] [-q|--quiet] [<stash>] | |
656b5034 | 15 | 'git stash' branch <branchname> [<stash>] |
1ada5020 TG |
16 | 'git stash' save [-p|--patch] [-k|--[no-]keep-index] [-q|--quiet] |
17 | [-u|--include-untracked] [-a|--all] [<message>] | |
18 | 'git stash' [push [-p|--patch] [-k|--[no-]keep-index] [-q|--quiet] | |
f5727e26 | 19 | [-u|--include-untracked] [-a|--all] [-m|--message <message>]] |
1ada5020 | 20 | [--] [<pathspec>...]] |
656b5034 | 21 | 'git stash' clear |
2be43516 | 22 | 'git stash' create [<message>] |
bd514cad | 23 | 'git stash' store [-m|--message <message>] [-q|--quiet] <commit> |
09ccdb63 NS |
24 | |
25 | DESCRIPTION | |
26 | ----------- | |
27 | ||
ca768288 | 28 | Use `git stash` when you want to record the current state of the |
09ccdb63 NS |
29 | working directory and the index, but want to go back to a clean |
30 | working directory. The command saves your local modifications away | |
31 | and reverts the working directory to match the `HEAD` commit. | |
32 | ||
33 | The modifications stashed away by this command can be listed with | |
483bc4f0 JN |
34 | `git stash list`, inspected with `git stash show`, and restored |
35 | (potentially on top of a different commit) with `git stash apply`. | |
db37745e | 36 | Calling `git stash` without any arguments is equivalent to `git stash push`. |
483bc4f0 | 37 | A stash is by default listed as "WIP on 'branchname' ...", but |
ec96e0f6 NS |
38 | you can give a more descriptive message on the command line when |
39 | you create one. | |
09ccdb63 | 40 | |
cc1b8d8b | 41 | The latest stash you created is stored in `refs/stash`; older |
9488e875 | 42 | stashes are found in the reflog of this reference and can be named using |
6cf378f0 JK |
43 | the usual reflog syntax (e.g. `stash@{0}` is the most recently |
44 | created stash, `stash@{1}` is the one before it, `stash@{2.hours.ago}` | |
a56c8f5a AW |
45 | is also possible). Stashes may also be referenced by specifying just the |
46 | stash index (e.g. the integer `n` is equivalent to `stash@{n}`). | |
09ccdb63 NS |
47 | |
48 | OPTIONS | |
49 | ------- | |
50 | ||
c20aec05 | 51 | save [-p|--patch] [-k|--[no-]keep-index] [-u|--include-untracked] [-a|--all] [-q|--quiet] [<message>]:: |
df6bba09 | 52 | push [-p|--patch] [-k|--[no-]keep-index] [-u|--include-untracked] [-a|--all] [-q|--quiet] [-m|--message <message>] [--] [<pathspec>...]:: |
09ccdb63 | 53 | |
e01db917 | 54 | Save your local modifications to a new 'stash entry' and roll them |
20a7e061 TG |
55 | back to HEAD (in the working tree and in the index). |
56 | The <message> part is optional and gives | |
9e140909 TG |
57 | the description along with the stashed state. |
58 | + | |
59 | For quickly making a snapshot, you can omit "push". In this mode, | |
60 | non-option arguments are not allowed to prevent a misspelled | |
e01db917 | 61 | subcommand from making an unwanted stash entry. The two exceptions to this |
9e140909 TG |
62 | are `stash -p` which acts as alias for `stash push -p` and pathspecs, |
63 | which are allowed after a double hyphen `--` for disambiguation. | |
7bedebca | 64 | + |
e01db917 | 65 | When pathspec is given to 'git stash push', the new stash entry records the |
df6bba09 TG |
66 | modified states only for the files that match the pathspec. The index |
67 | entries and working tree files are then rolled back to the state in | |
68 | HEAD only for these files, too, leaving files that do not match the | |
69 | pathspec intact. | |
70 | + | |
7bedebca SG |
71 | If the `--keep-index` option is used, all changes already added to the |
72 | index are left intact. | |
dda1f2a5 | 73 | + |
78751302 DC |
74 | If the `--include-untracked` option is used, all untracked files are also |
75 | stashed and then cleaned up with `git clean`, leaving the working directory | |
76 | in a very clean state. If the `--all` option is used instead then the | |
77 | ignored files are stashed and cleaned in addition to the untracked files. | |
78 | + | |
f2808a50 | 79 | With `--patch`, you can interactively select hunks from the diff |
dda1f2a5 TR |
80 | between HEAD and the working tree to be stashed. The stash entry is |
81 | constructed such that its index state is the same as the index state | |
82 | of your repository, and its worktree contains only the changes you | |
83 | selected interactively. The selected changes are then rolled back | |
f2808a50 | 84 | from your worktree. See the ``Interactive Mode'' section of |
6cf378f0 | 85 | linkgit:git-add[1] to learn how to operate the `--patch` mode. |
dda1f2a5 TR |
86 | + |
87 | The `--patch` option implies `--keep-index`. You can use | |
88 | `--no-keep-index` to override this. | |
09ccdb63 | 89 | |
fbd538c2 | 90 | list [<options>]:: |
09ccdb63 | 91 | |
e01db917 LB |
92 | List the stash entries that you currently have. Each 'stash entry' is |
93 | listed with its name (e.g. `stash@{0}` is the latest entry, `stash@{1}` is | |
9488e875 | 94 | the one before, etc.), the name of the branch that was current when the |
e01db917 | 95 | entry was made, and a short description of the commit the entry was |
09ccdb63 NS |
96 | based on. |
97 | + | |
98 | ---------------------------------------------------------------- | |
ec96e0f6 NS |
99 | stash@{0}: WIP on submit: 6ebd0e2... Update git-stash documentation |
100 | stash@{1}: On master: 9cc0589... Add git-stash | |
09ccdb63 | 101 | ---------------------------------------------------------------- |
fbd538c2 | 102 | + |
0b444cdb | 103 | The command takes options applicable to the 'git log' |
b7b10385 | 104 | command to control what is shown and how. See linkgit:git-log[1]. |
09ccdb63 NS |
105 | |
106 | show [<stash>]:: | |
107 | ||
e01db917 LB |
108 | Show the changes recorded in the stash entry as a diff between the |
109 | stashed contents and the commit back when the stash entry was first | |
110 | created. When no `<stash>` is given, it shows the latest one. | |
111 | By default, the command shows the diffstat, but it will accept any | |
112 | format known to 'git diff' (e.g., `git stash show -p stash@{1}` | |
113 | to view the second most recent entry in patch form). | |
3086c064 NK |
114 | You can use stash.showStat and/or stash.showPatch config variables |
115 | to change the default behavior. | |
09ccdb63 | 116 | |
fcdd0e92 | 117 | pop [--index] [-q|--quiet] [<stash>]:: |
09ccdb63 | 118 | |
d1836637 TR |
119 | Remove a single stashed state from the stash list and apply it |
120 | on top of the current working tree state, i.e., do the inverse | |
db37745e | 121 | operation of `git stash push`. The working directory must |
d1836637 | 122 | match the index. |
9488e875 | 123 | + |
d1836637 TR |
124 | Applying the state can fail with conflicts; in this case, it is not |
125 | removed from the stash list. You need to resolve the conflicts by hand | |
126 | and call `git stash drop` manually afterwards. | |
127 | + | |
0bdcac56 MV |
128 | If the `--index` option is used, then tries to reinstate not only the working |
129 | tree's changes, but also the index's ones. However, this can fail, when you | |
130 | have conflicts (which are stored in the index, where you therefore can no | |
131 | longer apply the changes as they were originally). | |
f39d6ee2 | 132 | + |
6cf378f0 JK |
133 | When no `<stash>` is given, `stash@{0}` is assumed, otherwise `<stash>` must |
134 | be a reference of the form `stash@{<revision>}`. | |
f39d6ee2 | 135 | |
fcdd0e92 | 136 | apply [--index] [-q|--quiet] [<stash>]:: |
f39d6ee2 | 137 | |
b0c6bf4a JS |
138 | Like `pop`, but do not remove the state from the stash list. Unlike `pop`, |
139 | `<stash>` may be any commit that looks like a commit created by | |
db37745e | 140 | `stash push` or `stash create`. |
09ccdb63 | 141 | |
656b5034 AMS |
142 | branch <branchname> [<stash>]:: |
143 | ||
144 | Creates and checks out a new branch named `<branchname>` starting from | |
145 | the commit at which the `<stash>` was originally created, applies the | |
b0c6bf4a JS |
146 | changes recorded in `<stash>` to the new working tree and index. |
147 | If that succeeds, and `<stash>` is a reference of the form | |
148 | `stash@{<revision>}`, it then drops the `<stash>`. When no `<stash>` | |
656b5034 AMS |
149 | is given, applies the latest one. |
150 | + | |
db37745e | 151 | This is useful if the branch on which you ran `git stash push` has |
656b5034 | 152 | changed enough that `git stash apply` fails due to conflicts. Since |
e01db917 LB |
153 | the stash entry is applied on top of the commit that was HEAD at the |
154 | time `git stash` was run, it restores the originally stashed state | |
155 | with no conflicts. | |
656b5034 | 156 | |
09ccdb63 | 157 | clear:: |
e01db917 | 158 | Remove all the stash entries. Note that those entries will then |
f5f1e164 TR |
159 | be subject to pruning, and may be impossible to recover (see |
160 | 'Examples' below for a possible strategy). | |
09ccdb63 | 161 | |
fcdd0e92 | 162 | drop [-q|--quiet] [<stash>]:: |
e25d5f9c | 163 | |
e01db917 LB |
164 | Remove a single stash entry from the list of stash entries. |
165 | When no `<stash>` is given, it removes the latest one. | |
166 | i.e. `stash@{0}`, otherwise `<stash>` must be a valid stash | |
167 | log reference of the form `stash@{<revision>}`. | |
e25d5f9c | 168 | |
a5ab00c5 SB |
169 | create:: |
170 | ||
e01db917 LB |
171 | Create a stash entry (which is a regular commit object) and |
172 | return its object name, without storing it anywhere in the ref | |
173 | namespace. | |
2be43516 RR |
174 | This is intended to be useful for scripts. It is probably not |
175 | the command you want to use; see "save" above. | |
a5ab00c5 | 176 | |
bd514cad RR |
177 | store:: |
178 | ||
179 | Store a given stash created via 'git stash create' (which is a | |
180 | dangling merge commit) in the stash ref, updating the stash | |
181 | reflog. This is intended to be useful for scripts. It is | |
182 | probably not the command you want to use; see "save" above. | |
09ccdb63 NS |
183 | |
184 | DISCUSSION | |
185 | ---------- | |
186 | ||
e01db917 LB |
187 | A stash entry is represented as a commit whose tree records the state |
188 | of the working directory, and its first parent is the commit at `HEAD` | |
189 | when the entry was created. The tree of the second parent records the | |
190 | state of the index when the entry is made, and it is made a child of | |
09ccdb63 NS |
191 | the `HEAD` commit. The ancestry graph looks like this: |
192 | ||
193 | .----W | |
194 | / / | |
114fd812 | 195 | -----H----I |
09ccdb63 NS |
196 | |
197 | where `H` is the `HEAD` commit, `I` is a commit that records the state | |
198 | of the index, and `W` is a commit that records the state of the working | |
199 | tree. | |
200 | ||
201 | ||
202 | EXAMPLES | |
203 | -------- | |
204 | ||
205 | Pulling into a dirty tree:: | |
206 | ||
207 | When you are in the middle of something, you learn that there are | |
9488e875 JH |
208 | upstream changes that are possibly relevant to what you are |
209 | doing. When your local changes do not conflict with the changes in | |
09ccdb63 NS |
210 | the upstream, a simple `git pull` will let you move forward. |
211 | + | |
212 | However, there are cases in which your local changes do conflict with | |
213 | the upstream changes, and `git pull` refuses to overwrite your | |
9488e875 | 214 | changes. In such a case, you can stash your changes away, |
09ccdb63 NS |
215 | perform a pull, and then unstash, like this: |
216 | + | |
217 | ---------------------------------------------------------------- | |
218 | $ git pull | |
9da6f0ff | 219 | ... |
09ccdb63 NS |
220 | file foobar not up to date, cannot merge. |
221 | $ git stash | |
222 | $ git pull | |
d1836637 | 223 | $ git stash pop |
09ccdb63 NS |
224 | ---------------------------------------------------------------- |
225 | ||
226 | Interrupted workflow:: | |
227 | ||
228 | When you are in the middle of something, your boss comes in and | |
9488e875 | 229 | demands that you fix something immediately. Traditionally, you would |
09ccdb63 | 230 | make a commit to a temporary branch to store your changes away, and |
9488e875 | 231 | return to your original branch to make the emergency fix, like this: |
09ccdb63 NS |
232 | + |
233 | ---------------------------------------------------------------- | |
9da6f0ff | 234 | # ... hack hack hack ... |
09ccdb63 NS |
235 | $ git checkout -b my_wip |
236 | $ git commit -a -m "WIP" | |
237 | $ git checkout master | |
238 | $ edit emergency fix | |
239 | $ git commit -a -m "Fix in a hurry" | |
240 | $ git checkout my_wip | |
241 | $ git reset --soft HEAD^ | |
9da6f0ff | 242 | # ... continue hacking ... |
09ccdb63 NS |
243 | ---------------------------------------------------------------- |
244 | + | |
0b444cdb | 245 | You can use 'git stash' to simplify the above, like this: |
09ccdb63 NS |
246 | + |
247 | ---------------------------------------------------------------- | |
9da6f0ff | 248 | # ... hack hack hack ... |
09ccdb63 NS |
249 | $ git stash |
250 | $ edit emergency fix | |
251 | $ git commit -a -m "Fix in a hurry" | |
d1836637 | 252 | $ git stash pop |
9da6f0ff | 253 | # ... continue hacking ... |
09ccdb63 NS |
254 | ---------------------------------------------------------------- |
255 | ||
7bedebca SG |
256 | Testing partial commits:: |
257 | ||
db37745e | 258 | You can use `git stash push --keep-index` when you want to make two or |
7bedebca SG |
259 | more commits out of the changes in the work tree, and you want to test |
260 | each change before committing: | |
261 | + | |
262 | ---------------------------------------------------------------- | |
9da6f0ff | 263 | # ... hack hack hack ... |
caf18996 | 264 | $ git add --patch foo # add just first part to the index |
db37745e | 265 | $ git stash push --keep-index # save all other changes to the stash |
caf18996 | 266 | $ edit/build/test first part |
f733c709 | 267 | $ git commit -m 'First part' # commit fully tested change |
caf18996 | 268 | $ git stash pop # prepare to work on all other changes |
9da6f0ff | 269 | # ... repeat above five steps until one commit remains ... |
caf18996 ER |
270 | $ edit/build/test remaining parts |
271 | $ git commit foo -m 'Remaining parts' | |
7bedebca SG |
272 | ---------------------------------------------------------------- |
273 | ||
e01db917 | 274 | Recovering stash entries that were cleared/dropped erroneously:: |
f5f1e164 | 275 | |
e01db917 | 276 | If you mistakenly drop or clear stash entries, they cannot be recovered |
f5f1e164 | 277 | through the normal safety mechanisms. However, you can try the |
e01db917 LB |
278 | following incantation to get a list of stash entries that are still in |
279 | your repository, but not reachable any more: | |
f5f1e164 TR |
280 | + |
281 | ---------------------------------------------------------------- | |
282 | git fsck --unreachable | | |
283 | grep commit | cut -d\ -f3 | | |
284 | xargs git log --merges --no-walk --grep=WIP | |
285 | ---------------------------------------------------------------- | |
286 | ||
287 | ||
09ccdb63 NS |
288 | SEE ALSO |
289 | -------- | |
5162e697 DM |
290 | linkgit:git-checkout[1], |
291 | linkgit:git-commit[1], | |
292 | linkgit:git-reflog[1], | |
293 | linkgit:git-reset[1] | |
09ccdb63 | 294 | |
09ccdb63 NS |
295 | GIT |
296 | --- | |
9e1f0a85 | 297 | Part of the linkgit:git[1] suite |