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