imap-send: support subjectAltName as well
[git/jnareb-git.git] / Documentation / git-stash.txt
blob15f051fa44e4b2e90da8383318c62695359772ce
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] [<message>]]
17 'git stash' clear
18 'git stash' create
20 DESCRIPTION
21 -----------
23 Use `git stash` when you want to record the current state of the
24 working directory and the index, but want to go back to a clean
25 working directory.  The command saves your local modifications away
26 and reverts the working directory to match the `HEAD` commit.
28 The modifications stashed away by this command can be listed with
29 `git stash list`, inspected with `git stash show`, and restored
30 (potentially on top of a different commit) with `git stash apply`.
31 Calling `git stash` without any arguments is equivalent to `git stash save`.
32 A stash is by default listed as "WIP on 'branchname' ...", but
33 you can give a more descriptive message on the command line when
34 you create one.
36 The latest stash you created is stored in `refs/stash`; older
37 stashes are found in the reflog of this reference and can be named using
38 the usual reflog syntax (e.g. `stash@\{0}` is the most recently
39 created stash, `stash@\{1}` is the one before it, `stash@\{2.hours.ago}`
40 is also possible).
42 OPTIONS
43 -------
45 save [-p|--patch] [--[no-]keep-index] [-q|--quiet] [<message>]::
47         Save your local modifications to a new 'stash', and run `git reset
48         --hard` to revert them.  The <message> part is optional and gives
49         the description along with the stashed state.  For quickly making
50         a snapshot, you can omit _both_ "save" and <message>, but giving
51         only <message> does not trigger this action to prevent a misspelled
52         subcommand from making an unwanted stash.
54 If the `--keep-index` option is used, all changes already added to the
55 index are left intact.
57 With `--patch`, you can interactively select hunks from the diff
58 between HEAD and the working tree to be stashed.  The stash entry is
59 constructed such that its index state is the same as the index state
60 of your repository, and its worktree contains only the changes you
61 selected interactively.  The selected changes are then rolled back
62 from your worktree. See the ``Interactive Mode'' section of
63 linkgit:git-add[1] to learn how to operate the `\--patch` mode.
65 The `--patch` option implies `--keep-index`.  You can use
66 `--no-keep-index` to override this.
68 list [<options>]::
70         List the stashes that you currently have.  Each 'stash' is listed
71         with its name (e.g. `stash@\{0}` is the latest stash, `stash@\{1}` is
72         the one before, etc.), the name of the branch that was current when the
73         stash was made, and a short description of the commit the stash was
74         based on.
76 ----------------------------------------------------------------
77 stash@{0}: WIP on submit: 6ebd0e2... Update git-stash documentation
78 stash@{1}: On master: 9cc0589... Add git-stash
79 ----------------------------------------------------------------
81 The command takes options applicable to the 'git log'
82 command to control what is shown and how. See linkgit:git-log[1].
84 show [<stash>]::
86         Show the changes recorded in the stash as a diff between the
87         stashed state and its original parent. When no `<stash>` is given,
88         shows the latest one. By default, the command shows the diffstat, but
89         it will accept any format known to 'git diff' (e.g., `git stash show
90         -p stash@\{1}` to view the second most recent stash in patch form).
92 pop [--index] [-q|--quiet] [<stash>]::
94         Remove a single stashed state from the stash list and apply it
95         on top of the current working tree state, i.e., do the inverse
96         operation of `git stash save`. The working directory must
97         match the index.
99 Applying the state can fail with conflicts; in this case, it is not
100 removed from the stash list. You need to resolve the conflicts by hand
101 and call `git stash drop` manually afterwards.
103 If the `--index` option is used, then tries to reinstate not only the working
104 tree's changes, but also the index's ones. However, this can fail, when you
105 have conflicts (which are stored in the index, where you therefore can no
106 longer apply the changes as they were originally).
108 When no `<stash>` is given, `stash@\{0}` is assumed, otherwise `<stash>` must
109 be a reference of the form `stash@\{<revision>}`.
111 apply [--index] [-q|--quiet] [<stash>]::
113         Like `pop`, but do not remove the state from the stash list. Unlike `pop`,
114         `<stash>` may be any commit that looks like a commit created by
115         `stash save` or `stash create`.
117 branch <branchname> [<stash>]::
119         Creates and checks out a new branch named `<branchname>` starting from
120         the commit at which the `<stash>` was originally created, applies the
121         changes recorded in `<stash>` to the new working tree and index.
122         If that succeeds, and `<stash>` is a reference of the form
123         `stash@{<revision>}`, it then drops the `<stash>`. When no `<stash>`
124         is given, applies the latest one.
126 This is useful if the branch on which you ran `git stash save` has
127 changed enough that `git stash apply` fails due to conflicts. Since
128 the stash is applied on top of the commit that was HEAD at the time
129 `git stash` was run, it restores the originally stashed state with
130 no conflicts.
132 clear::
133         Remove all the stashed states. Note that those states will then
134         be subject to pruning, and may be impossible to recover (see
135         'Examples' below for a possible strategy).
137 drop [-q|--quiet] [<stash>]::
139         Remove a single stashed state from the stash list. When no `<stash>`
140         is given, it removes the latest one. i.e. `stash@\{0}`, otherwise
141         `<stash>` must a valid stash log reference of the form
142         `stash@\{<revision>}`.
144 create::
146         Create a stash (which is a regular commit object) and return its
147         object name, without storing it anywhere in the ref namespace.
150 DISCUSSION
151 ----------
153 A stash is represented as a commit whose tree records the state of the
154 working directory, and its first parent is the commit at `HEAD` when
155 the stash was created.  The tree of the second parent records the
156 state of the index when the stash is made, and it is made a child of
157 the `HEAD` commit.  The ancestry graph looks like this:
159             .----W
160            /    /
161      -----H----I
163 where `H` is the `HEAD` commit, `I` is a commit that records the state
164 of the index, and `W` is a commit that records the state of the working
165 tree.
168 EXAMPLES
169 --------
171 Pulling into a dirty tree::
173 When you are in the middle of something, you learn that there are
174 upstream changes that are possibly relevant to what you are
175 doing.  When your local changes do not conflict with the changes in
176 the upstream, a simple `git pull` will let you move forward.
178 However, there are cases in which your local changes do conflict with
179 the upstream changes, and `git pull` refuses to overwrite your
180 changes.  In such a case, you can stash your changes away,
181 perform a pull, and then unstash, like this:
183 ----------------------------------------------------------------
184 $ git pull
185  ...
186 file foobar not up to date, cannot merge.
187 $ git stash
188 $ git pull
189 $ git stash pop
190 ----------------------------------------------------------------
192 Interrupted workflow::
194 When you are in the middle of something, your boss comes in and
195 demands that you fix something immediately.  Traditionally, you would
196 make a commit to a temporary branch to store your changes away, and
197 return to your original branch to make the emergency fix, like this:
199 ----------------------------------------------------------------
200 # ... hack hack hack ...
201 $ git checkout -b my_wip
202 $ git commit -a -m "WIP"
203 $ git checkout master
204 $ edit emergency fix
205 $ git commit -a -m "Fix in a hurry"
206 $ git checkout my_wip
207 $ git reset --soft HEAD^
208 # ... continue hacking ...
209 ----------------------------------------------------------------
211 You can use 'git stash' to simplify the above, like this:
213 ----------------------------------------------------------------
214 # ... hack hack hack ...
215 $ git stash
216 $ edit emergency fix
217 $ git commit -a -m "Fix in a hurry"
218 $ git stash pop
219 # ... continue hacking ...
220 ----------------------------------------------------------------
222 Testing partial commits::
224 You can use `git stash save --keep-index` when you want to make two or
225 more commits out of the changes in the work tree, and you want to test
226 each change before committing:
228 ----------------------------------------------------------------
229 # ... hack hack hack ...
230 $ git add --patch foo            # add just first part to the index
231 $ git stash save --keep-index    # save all other changes to the stash
232 $ edit/build/test first part
233 $ git commit -m 'First part'     # commit fully tested change
234 $ git stash pop                  # prepare to work on all other changes
235 # ... repeat above five steps until one commit remains ...
236 $ edit/build/test remaining parts
237 $ git commit foo -m 'Remaining parts'
238 ----------------------------------------------------------------
240 Recovering stashes that were cleared/dropped erroneously::
242 If you mistakenly drop or clear stashes, they cannot be recovered
243 through the normal safety mechanisms.  However, you can try the
244 following incantation to get a list of stashes that are still in your
245 repository, but not reachable any more:
247 ----------------------------------------------------------------
248 git fsck --unreachable |
249 grep commit | cut -d\  -f3 |
250 xargs git log --merges --no-walk --grep=WIP
251 ----------------------------------------------------------------
254 SEE ALSO
255 --------
256 linkgit:git-checkout[1],
257 linkgit:git-commit[1],
258 linkgit:git-reflog[1],
259 linkgit:git-reset[1]
263 Part of the linkgit:git[1] suite