dir.h: move struct exclude declaration to top level
[git.git] / Documentation / git-stash.txt
blob375213fe463fa3cd9cb7644cff60ee656c13dcd8
1 git-stash(1)
2 ============
4 NAME
5 ----
6 git-stash - Stash the changes in a dirty working directory away
8 SYNOPSIS
9 --------
10 [verse]
11 'git stash' list [<options>]
12 'git stash' show [<stash>]
13 'git stash' drop [-q|--quiet] [<stash>]
14 'git stash' ( pop | apply ) [--index] [-q|--quiet] [<stash>]
15 'git stash' branch <branchname> [<stash>]
16 'git stash' [save [-p|--patch] [-k|--[no-]keep-index] [-q|--quiet]
17              [-u|--include-untracked] [-a|--all] [<message>]]
18 'git stash' clear
19 'git stash' create [<message>]
20 'git stash' store [-m|--message <message>] [-q|--quiet] <commit>
22 DESCRIPTION
23 -----------
25 Use `git stash` when you want to record the current state of the
26 working directory and the index, but want to go back to a clean
27 working directory.  The command saves your local modifications away
28 and reverts the working directory to match the `HEAD` commit.
30 The modifications stashed away by this command can be listed with
31 `git stash list`, inspected with `git stash show`, and restored
32 (potentially on top of a different commit) with `git stash apply`.
33 Calling `git stash` without any arguments is equivalent to `git stash save`.
34 A stash is by default listed as "WIP on 'branchname' ...", but
35 you can give a more descriptive message on the command line when
36 you create one.
38 The latest stash you created is stored in `refs/stash`; older
39 stashes are found in the reflog of this reference and can be named using
40 the usual reflog syntax (e.g. `stash@{0}` is the most recently
41 created stash, `stash@{1}` is the one before it, `stash@{2.hours.ago}`
42 is also possible).
44 OPTIONS
45 -------
47 save [-p|--patch] [-k|--[no-]keep-index] [-u|--include-untracked] [-a|--all] [-q|--quiet] [<message>]::
49         Save your local modifications to a new 'stash', and run `git reset
50         --hard` to revert them.  The <message> part is optional and gives
51         the description along with the stashed state.  For quickly making
52         a snapshot, you can omit _both_ "save" and <message>, but giving
53         only <message> does not trigger this action to prevent a misspelled
54         subcommand from making an unwanted stash.
56 If the `--keep-index` option is used, all changes already added to the
57 index are left intact.
59 If the `--include-untracked` option is used, all untracked files are also
60 stashed and then cleaned up with `git clean`, leaving the working directory
61 in a very clean state. If the `--all` option is used instead then the
62 ignored files are stashed and cleaned in addition to the untracked files.
64 With `--patch`, you can interactively select hunks from the diff
65 between HEAD and the working tree to be stashed.  The stash entry is
66 constructed such that its index state is the same as the index state
67 of your repository, and its worktree contains only the changes you
68 selected interactively.  The selected changes are then rolled back
69 from your worktree. See the ``Interactive Mode'' section of
70 linkgit:git-add[1] to learn how to operate the `--patch` mode.
72 The `--patch` option implies `--keep-index`.  You can use
73 `--no-keep-index` to override this.
75 list [<options>]::
77         List the stashes that you currently have.  Each 'stash' is listed
78         with its name (e.g. `stash@{0}` is the latest stash, `stash@{1}` is
79         the one before, etc.), the name of the branch that was current when the
80         stash was made, and a short description of the commit the stash was
81         based on.
83 ----------------------------------------------------------------
84 stash@{0}: WIP on submit: 6ebd0e2... Update git-stash documentation
85 stash@{1}: On master: 9cc0589... Add git-stash
86 ----------------------------------------------------------------
88 The command takes options applicable to the 'git log'
89 command to control what is shown and how. See linkgit:git-log[1].
91 show [<stash>]::
93         Show the changes recorded in the stash as a diff between the
94         stashed state and its original parent. When no `<stash>` is given,
95         shows the latest one. By default, the command shows the diffstat, but
96         it will accept any format known to 'git diff' (e.g., `git stash show
97         -p stash@{1}` to view the second most recent stash in patch form).
99 pop [--index] [-q|--quiet] [<stash>]::
101         Remove a single stashed state from the stash list and apply it
102         on top of the current working tree state, i.e., do the inverse
103         operation of `git stash save`. The working directory must
104         match the index.
106 Applying the state can fail with conflicts; in this case, it is not
107 removed from the stash list. You need to resolve the conflicts by hand
108 and call `git stash drop` manually afterwards.
110 If the `--index` option is used, then tries to reinstate not only the working
111 tree's changes, but also the index's ones. However, this can fail, when you
112 have conflicts (which are stored in the index, where you therefore can no
113 longer apply the changes as they were originally).
115 When no `<stash>` is given, `stash@{0}` is assumed, otherwise `<stash>` must
116 be a reference of the form `stash@{<revision>}`.
118 apply [--index] [-q|--quiet] [<stash>]::
120         Like `pop`, but do not remove the state from the stash list. Unlike `pop`,
121         `<stash>` may be any commit that looks like a commit created by
122         `stash save` or `stash create`.
124 branch <branchname> [<stash>]::
126         Creates and checks out a new branch named `<branchname>` starting from
127         the commit at which the `<stash>` was originally created, applies the
128         changes recorded in `<stash>` to the new working tree and index.
129         If that succeeds, and `<stash>` is a reference of the form
130         `stash@{<revision>}`, it then drops the `<stash>`. When no `<stash>`
131         is given, applies the latest one.
133 This is useful if the branch on which you ran `git stash save` has
134 changed enough that `git stash apply` fails due to conflicts. Since
135 the stash is applied on top of the commit that was HEAD at the time
136 `git stash` was run, it restores the originally stashed state with
137 no conflicts.
139 clear::
140         Remove all the stashed states. Note that those states will then
141         be subject to pruning, and may be impossible to recover (see
142         'Examples' below for a possible strategy).
144 drop [-q|--quiet] [<stash>]::
146         Remove a single stashed state from the stash list. When no `<stash>`
147         is given, it removes the latest one. i.e. `stash@{0}`, otherwise
148         `<stash>` must be a valid stash log reference of the form
149         `stash@{<revision>}`.
151 create::
153         Create a stash (which is a regular commit object) and return its
154         object name, without storing it anywhere in the ref namespace.
155         This is intended to be useful for scripts.  It is probably not
156         the command you want to use; see "save" above.
158 store::
160         Store a given stash created via 'git stash create' (which is a
161         dangling merge commit) in the stash ref, updating the stash
162         reflog.  This is intended to be useful for scripts.  It is
163         probably not the command you want to use; see "save" above.
165 DISCUSSION
166 ----------
168 A stash is represented as a commit whose tree records the state of the
169 working directory, and its first parent is the commit at `HEAD` when
170 the stash was created.  The tree of the second parent records the
171 state of the index when the stash is made, and it is made a child of
172 the `HEAD` commit.  The ancestry graph looks like this:
174             .----W
175            /    /
176      -----H----I
178 where `H` is the `HEAD` commit, `I` is a commit that records the state
179 of the index, and `W` is a commit that records the state of the working
180 tree.
183 EXAMPLES
184 --------
186 Pulling into a dirty tree::
188 When you are in the middle of something, you learn that there are
189 upstream changes that are possibly relevant to what you are
190 doing.  When your local changes do not conflict with the changes in
191 the upstream, a simple `git pull` will let you move forward.
193 However, there are cases in which your local changes do conflict with
194 the upstream changes, and `git pull` refuses to overwrite your
195 changes.  In such a case, you can stash your changes away,
196 perform a pull, and then unstash, like this:
198 ----------------------------------------------------------------
199 $ git pull
200  ...
201 file foobar not up to date, cannot merge.
202 $ git stash
203 $ git pull
204 $ git stash pop
205 ----------------------------------------------------------------
207 Interrupted workflow::
209 When you are in the middle of something, your boss comes in and
210 demands that you fix something immediately.  Traditionally, you would
211 make a commit to a temporary branch to store your changes away, and
212 return to your original branch to make the emergency fix, like this:
214 ----------------------------------------------------------------
215 # ... hack hack hack ...
216 $ git checkout -b my_wip
217 $ git commit -a -m "WIP"
218 $ git checkout master
219 $ edit emergency fix
220 $ git commit -a -m "Fix in a hurry"
221 $ git checkout my_wip
222 $ git reset --soft HEAD^
223 # ... continue hacking ...
224 ----------------------------------------------------------------
226 You can use 'git stash' to simplify the above, like this:
228 ----------------------------------------------------------------
229 # ... hack hack hack ...
230 $ git stash
231 $ edit emergency fix
232 $ git commit -a -m "Fix in a hurry"
233 $ git stash pop
234 # ... continue hacking ...
235 ----------------------------------------------------------------
237 Testing partial commits::
239 You can use `git stash save --keep-index` when you want to make two or
240 more commits out of the changes in the work tree, and you want to test
241 each change before committing:
243 ----------------------------------------------------------------
244 # ... hack hack hack ...
245 $ git add --patch foo            # add just first part to the index
246 $ git stash save --keep-index    # save all other changes to the stash
247 $ edit/build/test first part
248 $ git commit -m 'First part'     # commit fully tested change
249 $ git stash pop                  # prepare to work on all other changes
250 # ... repeat above five steps until one commit remains ...
251 $ edit/build/test remaining parts
252 $ git commit foo -m 'Remaining parts'
253 ----------------------------------------------------------------
255 Recovering stashes that were cleared/dropped erroneously::
257 If you mistakenly drop or clear stashes, they cannot be recovered
258 through the normal safety mechanisms.  However, you can try the
259 following incantation to get a list of stashes that are still in your
260 repository, but not reachable any more:
262 ----------------------------------------------------------------
263 git fsck --unreachable |
264 grep commit | cut -d\  -f3 |
265 xargs git log --merges --no-walk --grep=WIP
266 ----------------------------------------------------------------
269 SEE ALSO
270 --------
271 linkgit:git-checkout[1],
272 linkgit:git-commit[1],
273 linkgit:git-reflog[1],
274 linkgit:git-reset[1]
278 Part of the linkgit:git[1] suite