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