blob: 2e9cef06e64376e973eeb74e338d93dd99ae40ee [file] [log] [blame]
しらいしななこ09ccdb62007-07-01 14:26:08 +09001git-stash(1)
2============
3
4NAME
5----
6git-stash - Stash the changes in a dirty working directory away
7
8SYNOPSIS
9--------
10[verse]
Stephan Beyera5ab00c2008-08-16 05:27:31 +020011'git stash' list [<options>]
Stephen Boydfcdd0e92009-06-17 18:07:37 -070012'git stash' show [<stash>]
13'git stash' drop [-q|--quiet] [<stash>]
14'git stash' ( pop | apply ) [--index] [-q|--quiet] [<stash>]
Abhijit Menon-Sen656b5032008-07-03 11:46:05 +053015'git stash' branch <branchname> [<stash>]
Ramkumar Ramachandraaa7e7222013-06-15 18:43:23 +053016'git stash' [save [-p|--patch] [-k|--[no-]keep-index] [-q|--quiet]
Junio C Hamanoc1ebd902013-08-14 09:53:43 -070017 [-u|--include-untracked] [-a|--all] [<message>]]
Abhijit Menon-Sen656b5032008-07-03 11:46:05 +053018'git stash' clear
Ramkumar Ramachandra2be43512013-06-15 18:43:22 +053019'git stash' create [<message>]
Ramkumar Ramachandrabd514ca2013-06-15 18:43:25 +053020'git stash' store [-m|--message <message>] [-q|--quiet] <commit>
しらいしななこ09ccdb62007-07-01 14:26:08 +090021
22DESCRIPTION
23-----------
24
Thomas Rastca768282010-01-07 17:49:12 +010025Use `git stash` when you want to record the current state of the
しらいしななこ09ccdb62007-07-01 14:26:08 +090026working directory and the index, but want to go back to a clean
27working directory. The command saves your local modifications away
28and reverts the working directory to match the `HEAD` commit.
29
30The modifications stashed away by this command can be listed with
Jonathan Nieder483bc4f2008-06-30 13:56:34 -050031`git stash list`, inspected with `git stash show`, and restored
32(potentially on top of a different commit) with `git stash apply`.
33Calling `git stash` without any arguments is equivalent to `git stash save`.
34A stash is by default listed as "WIP on 'branchname' ...", but
しらいしななこec96e0f2007-07-17 17:15:42 +090035you can give a more descriptive message on the command line when
36you create one.
しらいしななこ09ccdb62007-07-01 14:26:08 +090037
Jeff Kingcc1b8d82010-02-17 20:16:20 -050038The latest stash you created is stored in `refs/stash`; older
Junio C Hamano9488e872007-07-01 15:29:01 -070039stashes are found in the reflog of this reference and can be named using
Jeff King6cf378f2012-04-26 04:51:57 -040040the usual reflog syntax (e.g. `stash@{0}` is the most recently
41created stash, `stash@{1}` is the one before it, `stash@{2.hours.ago}`
Aaron M Watsona56c8f52016-10-24 19:40:13 -040042is also possible). Stashes may also be referenced by specifying just the
43stash index (e.g. the integer `n` is equivalent to `stash@{n}`).
しらいしななこ09ccdb62007-07-01 14:26:08 +090044
45OPTIONS
46-------
47
John Marshallc20aec02014-02-21 17:25:24 +000048save [-p|--patch] [-k|--[no-]keep-index] [-u|--include-untracked] [-a|--all] [-q|--quiet] [<message>]::
しらいしななこ09ccdb62007-07-01 14:26:08 +090049
Jonathan Niederb1889c32008-06-30 01:09:04 -050050 Save your local modifications to a new 'stash', and run `git reset
Matthieu Moy3c2eb802009-08-18 23:38:40 +020051 --hard` to revert them. The <message> part is optional and gives
52 the description along with the stashed state. For quickly making
53 a snapshot, you can omit _both_ "save" and <message>, but giving
54 only <message> does not trigger this action to prevent a misspelled
55 subcommand from making an unwanted stash.
SZEDER Gábor7bedebc2008-06-27 16:37:15 +020056+
57If the `--keep-index` option is used, all changes already added to the
58index are left intact.
Thomas Rastdda1f2a2009-08-13 14:29:44 +020059+
David Caldwell78751302011-06-24 17:56:06 -070060If the `--include-untracked` option is used, all untracked files are also
61stashed and then cleaned up with `git clean`, leaving the working directory
62in a very clean state. If the `--all` option is used instead then the
63ignored files are stashed and cleaned in addition to the untracked files.
64+
Valentin Haenelf2808a52011-05-05 20:48:47 +020065With `--patch`, you can interactively select hunks from the diff
Thomas Rastdda1f2a2009-08-13 14:29:44 +020066between HEAD and the working tree to be stashed. The stash entry is
67constructed such that its index state is the same as the index state
68of your repository, and its worktree contains only the changes you
69selected interactively. The selected changes are then rolled back
Valentin Haenelf2808a52011-05-05 20:48:47 +020070from your worktree. See the ``Interactive Mode'' section of
Jeff King6cf378f2012-04-26 04:51:57 -040071linkgit:git-add[1] to learn how to operate the `--patch` mode.
Thomas Rastdda1f2a2009-08-13 14:29:44 +020072+
73The `--patch` option implies `--keep-index`. You can use
74`--no-keep-index` to override this.
しらいしななこ09ccdb62007-07-01 14:26:08 +090075
Miklos Vajnafbd538c2008-02-20 12:31:35 +010076list [<options>]::
しらいしななこ09ccdb62007-07-01 14:26:08 +090077
78 List the stashes that you currently have. Each 'stash' is listed
Jeff King6cf378f2012-04-26 04:51:57 -040079 with its name (e.g. `stash@{0}` is the latest stash, `stash@{1}` is
Junio C Hamano9488e872007-07-01 15:29:01 -070080 the one before, etc.), the name of the branch that was current when the
しらいしななこ09ccdb62007-07-01 14:26:08 +090081 stash was made, and a short description of the commit the stash was
82 based on.
83+
84----------------------------------------------------------------
しらいしななこec96e0f2007-07-17 17:15:42 +090085stash@{0}: WIP on submit: 6ebd0e2... Update git-stash documentation
86stash@{1}: On master: 9cc0589... Add git-stash
しらいしななこ09ccdb62007-07-01 14:26:08 +090087----------------------------------------------------------------
Miklos Vajnafbd538c2008-02-20 12:31:35 +010088+
Thomas Rast0b444cd2010-01-10 00:33:00 +010089The command takes options applicable to the 'git log'
Thomas Rastb7b10382009-10-19 17:48:12 +020090command to control what is shown and how. See linkgit:git-log[1].
しらいしななこ09ccdb62007-07-01 14:26:08 +090091
92show [<stash>]::
93
Ralf Wildenhues06ada152007-10-09 23:00:03 +020094 Show the changes recorded in the stash as a diff between the
Junio C Hamano9488e872007-07-01 15:29:01 -070095 stashed state and its original parent. When no `<stash>` is given,
96 shows the latest one. By default, the command shows the diffstat, but
Thomas Rast0b444cd2010-01-10 00:33:00 +010097 it will accept any format known to 'git diff' (e.g., `git stash show
Jeff King6cf378f2012-04-26 04:51:57 -040098 -p stash@{1}` to view the second most recent stash in patch form).
Namhyung Kim3086c062015-08-30 00:25:57 +090099 You can use stash.showStat and/or stash.showPatch config variables
100 to change the default behavior.
しらいしななこ09ccdb62007-07-01 14:26:08 +0900101
Stephen Boydfcdd0e92009-06-17 18:07:37 -0700102pop [--index] [-q|--quiet] [<stash>]::
Thomas Rastd1836632009-05-28 11:40:15 +0200103
104 Remove a single stashed state from the stash list and apply it
105 on top of the current working tree state, i.e., do the inverse
106 operation of `git stash save`. The working directory must
107 match the index.
108+
109Applying the state can fail with conflicts; in this case, it is not
110removed from the stash list. You need to resolve the conflicts by hand
111and call `git stash drop` manually afterwards.
112+
Miklos Vajna0bdcac52007-10-01 00:30:27 +0200113If the `--index` option is used, then tries to reinstate not only the working
114tree's changes, but also the index's ones. However, this can fail, when you
115have conflicts (which are stored in the index, where you therefore can no
116longer apply the changes as they were originally).
SZEDER Gáborf39d6ee2009-06-09 00:57:06 +0200117+
Jeff King6cf378f2012-04-26 04:51:57 -0400118When no `<stash>` is given, `stash@{0}` is assumed, otherwise `<stash>` must
119be a reference of the form `stash@{<revision>}`.
SZEDER Gáborf39d6ee2009-06-09 00:57:06 +0200120
Stephen Boydfcdd0e92009-06-17 18:07:37 -0700121apply [--index] [-q|--quiet] [<stash>]::
SZEDER Gáborf39d6ee2009-06-09 00:57:06 +0200122
Jon Seymourb0c6bf42010-08-21 14:09:04 +1000123 Like `pop`, but do not remove the state from the stash list. Unlike `pop`,
124 `<stash>` may be any commit that looks like a commit created by
125 `stash save` or `stash create`.
しらいしななこ09ccdb62007-07-01 14:26:08 +0900126
Abhijit Menon-Sen656b5032008-07-03 11:46:05 +0530127branch <branchname> [<stash>]::
128
129 Creates and checks out a new branch named `<branchname>` starting from
130 the commit at which the `<stash>` was originally created, applies the
Jon Seymourb0c6bf42010-08-21 14:09:04 +1000131 changes recorded in `<stash>` to the new working tree and index.
132 If that succeeds, and `<stash>` is a reference of the form
133 `stash@{<revision>}`, it then drops the `<stash>`. When no `<stash>`
Abhijit Menon-Sen656b5032008-07-03 11:46:05 +0530134 is given, applies the latest one.
135+
136This is useful if the branch on which you ran `git stash save` has
137changed enough that `git stash apply` fails due to conflicts. Since
138the stash is applied on top of the commit that was HEAD at the time
139`git stash` was run, it restores the originally stashed state with
140no conflicts.
141
しらいしななこ09ccdb62007-07-01 14:26:08 +0900142clear::
Junio C Hamano9488e872007-07-01 15:29:01 -0700143 Remove all the stashed states. Note that those states will then
Thomas Rastf5f1e162009-08-09 02:47:36 +0200144 be subject to pruning, and may be impossible to recover (see
145 'Examples' below for a possible strategy).
しらいしななこ09ccdb62007-07-01 14:26:08 +0900146
Stephen Boydfcdd0e92009-06-17 18:07:37 -0700147drop [-q|--quiet] [<stash>]::
Brandon Caseye25d5f92008-02-22 13:04:54 -0600148
149 Remove a single stashed state from the stash list. When no `<stash>`
Jeff King6cf378f2012-04-26 04:51:57 -0400150 is given, it removes the latest one. i.e. `stash@{0}`, otherwise
Sébastien Loriot5badfdc2012-12-10 08:22:34 +0100151 `<stash>` must be a valid stash log reference of the form
Jeff King6cf378f2012-04-26 04:51:57 -0400152 `stash@{<revision>}`.
Brandon Caseye25d5f92008-02-22 13:04:54 -0600153
Stephan Beyera5ab00c2008-08-16 05:27:31 +0200154create::
155
156 Create a stash (which is a regular commit object) and return its
157 object name, without storing it anywhere in the ref namespace.
Ramkumar Ramachandra2be43512013-06-15 18:43:22 +0530158 This is intended to be useful for scripts. It is probably not
159 the command you want to use; see "save" above.
Stephan Beyera5ab00c2008-08-16 05:27:31 +0200160
Ramkumar Ramachandrabd514ca2013-06-15 18:43:25 +0530161store::
162
163 Store a given stash created via 'git stash create' (which is a
164 dangling merge commit) in the stash ref, updating the stash
165 reflog. This is intended to be useful for scripts. It is
166 probably not the command you want to use; see "save" above.
しらいしななこ09ccdb62007-07-01 14:26:08 +0900167
168DISCUSSION
169----------
170
171A stash is represented as a commit whose tree records the state of the
172working directory, and its first parent is the commit at `HEAD` when
173the stash was created. The tree of the second parent records the
174state of the index when the stash is made, and it is made a child of
175the `HEAD` commit. The ancestry graph looks like this:
176
177 .----W
178 / /
Junio C Hamano114fd812007-07-04 22:09:20 -0700179 -----H----I
しらいしななこ09ccdb62007-07-01 14:26:08 +0900180
181where `H` is the `HEAD` commit, `I` is a commit that records the state
182of the index, and `W` is a commit that records the state of the working
183tree.
184
185
186EXAMPLES
187--------
188
189Pulling into a dirty tree::
190
191When you are in the middle of something, you learn that there are
Junio C Hamano9488e872007-07-01 15:29:01 -0700192upstream changes that are possibly relevant to what you are
193doing. When your local changes do not conflict with the changes in
しらいしななこ09ccdb62007-07-01 14:26:08 +0900194the upstream, a simple `git pull` will let you move forward.
195+
196However, there are cases in which your local changes do conflict with
197the upstream changes, and `git pull` refuses to overwrite your
Junio C Hamano9488e872007-07-01 15:29:01 -0700198changes. In such a case, you can stash your changes away,
しらいしななこ09ccdb62007-07-01 14:26:08 +0900199perform a pull, and then unstash, like this:
200+
201----------------------------------------------------------------
202$ git pull
SZEDER Gábor9da6f0f2008-09-02 03:35:24 +0200203 ...
しらいしななこ09ccdb62007-07-01 14:26:08 +0900204file foobar not up to date, cannot merge.
205$ git stash
206$ git pull
Thomas Rastd1836632009-05-28 11:40:15 +0200207$ git stash pop
しらいしななこ09ccdb62007-07-01 14:26:08 +0900208----------------------------------------------------------------
209
210Interrupted workflow::
211
212When you are in the middle of something, your boss comes in and
Junio C Hamano9488e872007-07-01 15:29:01 -0700213demands that you fix something immediately. Traditionally, you would
しらいしななこ09ccdb62007-07-01 14:26:08 +0900214make a commit to a temporary branch to store your changes away, and
Junio C Hamano9488e872007-07-01 15:29:01 -0700215return to your original branch to make the emergency fix, like this:
しらいしななこ09ccdb62007-07-01 14:26:08 +0900216+
217----------------------------------------------------------------
SZEDER Gábor9da6f0f2008-09-02 03:35:24 +0200218# ... hack hack hack ...
しらいしななこ09ccdb62007-07-01 14:26:08 +0900219$ git checkout -b my_wip
220$ git commit -a -m "WIP"
221$ git checkout master
222$ edit emergency fix
223$ git commit -a -m "Fix in a hurry"
224$ git checkout my_wip
225$ git reset --soft HEAD^
SZEDER Gábor9da6f0f2008-09-02 03:35:24 +0200226# ... continue hacking ...
しらいしななこ09ccdb62007-07-01 14:26:08 +0900227----------------------------------------------------------------
228+
Thomas Rast0b444cd2010-01-10 00:33:00 +0100229You can use 'git stash' to simplify the above, like this:
しらいしななこ09ccdb62007-07-01 14:26:08 +0900230+
231----------------------------------------------------------------
SZEDER Gábor9da6f0f2008-09-02 03:35:24 +0200232# ... hack hack hack ...
しらいしななこ09ccdb62007-07-01 14:26:08 +0900233$ git stash
234$ edit emergency fix
235$ git commit -a -m "Fix in a hurry"
Thomas Rastd1836632009-05-28 11:40:15 +0200236$ git stash pop
SZEDER Gábor9da6f0f2008-09-02 03:35:24 +0200237# ... continue hacking ...
しらいしななこ09ccdb62007-07-01 14:26:08 +0900238----------------------------------------------------------------
239
SZEDER Gábor7bedebc2008-06-27 16:37:15 +0200240Testing partial commits::
241
242You can use `git stash save --keep-index` when you want to make two or
243more commits out of the changes in the work tree, and you want to test
244each change before committing:
245+
246----------------------------------------------------------------
SZEDER Gábor9da6f0f2008-09-02 03:35:24 +0200247# ... hack hack hack ...
Eric Raiblecaf18992008-07-08 00:40:56 -0700248$ git add --patch foo # add just first part to the index
249$ git stash save --keep-index # save all other changes to the stash
250$ edit/build/test first part
SZEDER Gáborf733c702008-09-02 03:45:01 +0200251$ git commit -m 'First part' # commit fully tested change
Eric Raiblecaf18992008-07-08 00:40:56 -0700252$ git stash pop # prepare to work on all other changes
SZEDER Gábor9da6f0f2008-09-02 03:35:24 +0200253# ... repeat above five steps until one commit remains ...
Eric Raiblecaf18992008-07-08 00:40:56 -0700254$ edit/build/test remaining parts
255$ git commit foo -m 'Remaining parts'
SZEDER Gábor7bedebc2008-06-27 16:37:15 +0200256----------------------------------------------------------------
257
Thomas Rastf5f1e162009-08-09 02:47:36 +0200258Recovering stashes that were cleared/dropped erroneously::
259
260If you mistakenly drop or clear stashes, they cannot be recovered
261through the normal safety mechanisms. However, you can try the
262following incantation to get a list of stashes that are still in your
263repository, but not reachable any more:
264+
265----------------------------------------------------------------
266git fsck --unreachable |
267grep commit | cut -d\ -f3 |
268xargs git log --merges --no-walk --grep=WIP
269----------------------------------------------------------------
270
271
しらいしななこ09ccdb62007-07-01 14:26:08 +0900272SEE ALSO
273--------
Dan McGee5162e692007-12-29 00:20:38 -0600274linkgit:git-checkout[1],
275linkgit:git-commit[1],
276linkgit:git-reflog[1],
277linkgit:git-reset[1]
しらいしななこ09ccdb62007-07-01 14:26:08 +0900278
しらいしななこ09ccdb62007-07-01 14:26:08 +0900279GIT
280---
Christian Couder9e1f0a82008-06-06 09:07:32 +0200281Part of the linkgit:git[1] suite