revision.c: make --date-order overriddable
[alt-git.git] / Documentation / git-stash.txt
blob48e6f5a3f7a85e886639381dfa70434ecdeccfc2
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 | show [<stash>] | apply [<stash>] | clear)
12 'git-stash' [save [<message>]]
14 DESCRIPTION
15 -----------
17 Use 'git-stash' when you want to record the current state of the
18 working directory and the index, but want to go back to a clean
19 working directory.  The command saves your local modifications away
20 and reverts the working directory to match the `HEAD` commit.
22 The modifications stashed away by this command can be listed with
23 `git-stash list`, inspected with `git-stash show`, and restored
24 (potentially on top of a different commit) with `git-stash apply`.
25 Calling git-stash without any arguments is equivalent to `git-stash
26 save`.  A stash is by default listed as "WIP on 'branchname' ...", but
27 you can give a more descriptive message on the command line when
28 you create one.
30 The latest stash you created is stored in `$GIT_DIR/refs/stash`; older
31 stashes are found in the reflog of this reference and can be named using
32 the usual reflog syntax (e.g. `stash@\{0}` is the most recently
33 created stash, `stash@\{1}` is the one before it, `stash@\{2.hours.ago}`
34 is also possible).
36 OPTIONS
37 -------
39 save [<message>]::
41         Save your local modifications to a new 'stash', and run `git-reset
42         --hard` to revert them.  This is the default action when no
43         subcommand is given. The <message> part is optional and gives
44         the description along with the stashed state.
46 list [<options>]::
48         List the stashes that you currently have.  Each 'stash' is listed
49         with its name (e.g. `stash@\{0}` is the latest stash, `stash@\{1}` is
50         the one before, etc.), the name of the branch that was current when the
51         stash was made, and a short description of the commit the stash was
52         based on.
54 ----------------------------------------------------------------
55 stash@{0}: WIP on submit: 6ebd0e2... Update git-stash documentation
56 stash@{1}: On master: 9cc0589... Add git-stash
57 ----------------------------------------------------------------
59 The command takes options applicable to the linkgit:git-log[1]
60 command to control what is shown and how.
62 show [<stash>]::
64         Show the changes recorded in the stash as a diff between the
65         stashed state and its original parent. When no `<stash>` is given,
66         shows the latest one. By default, the command shows the diffstat, but
67         it will accept any format known to `git-diff` (e.g., `git-stash show
68         -p stash@\{1}` to view the second most recent stash in patch form).
70 apply [--index] [<stash>]::
72         Restore the changes recorded in the stash on top of the current
73         working tree state.  When no `<stash>` is given, applies the latest
74         one.  The working directory must match the index.
76 This operation can fail with conflicts; you need to resolve them
77 by hand in the working tree.
79 If the `--index` option is used, then tries to reinstate not only the working
80 tree's changes, but also the index's ones. However, this can fail, when you
81 have conflicts (which are stored in the index, where you therefore can no
82 longer apply the changes as they were originally).
84 clear::
85         Remove all the stashed states. Note that those states will then
86         be subject to pruning, and may be difficult or impossible to recover.
89 DISCUSSION
90 ----------
92 A stash is represented as a commit whose tree records the state of the
93 working directory, and its first parent is the commit at `HEAD` when
94 the stash was created.  The tree of the second parent records the
95 state of the index when the stash is made, and it is made a child of
96 the `HEAD` commit.  The ancestry graph looks like this:
98             .----W
99            /    /
100      -----H----I
102 where `H` is the `HEAD` commit, `I` is a commit that records the state
103 of the index, and `W` is a commit that records the state of the working
104 tree.
107 EXAMPLES
108 --------
110 Pulling into a dirty tree::
112 When you are in the middle of something, you learn that there are
113 upstream changes that are possibly relevant to what you are
114 doing.  When your local changes do not conflict with the changes in
115 the upstream, a simple `git pull` will let you move forward.
117 However, there are cases in which your local changes do conflict with
118 the upstream changes, and `git pull` refuses to overwrite your
119 changes.  In such a case, you can stash your changes away,
120 perform a pull, and then unstash, like this:
122 ----------------------------------------------------------------
123 $ git pull
125 file foobar not up to date, cannot merge.
126 $ git stash
127 $ git pull
128 $ git stash apply
129 ----------------------------------------------------------------
131 Interrupted workflow::
133 When you are in the middle of something, your boss comes in and
134 demands that you fix something immediately.  Traditionally, you would
135 make a commit to a temporary branch to store your changes away, and
136 return to your original branch to make the emergency fix, like this:
138 ----------------------------------------------------------------
139 ... hack hack hack ...
140 $ git checkout -b my_wip
141 $ git commit -a -m "WIP"
142 $ git checkout master
143 $ edit emergency fix
144 $ git commit -a -m "Fix in a hurry"
145 $ git checkout my_wip
146 $ git reset --soft HEAD^
147 ... continue hacking ...
148 ----------------------------------------------------------------
150 You can use `git-stash` to simplify the above, like this:
152 ----------------------------------------------------------------
153 ... hack hack hack ...
154 $ git stash
155 $ edit emergency fix
156 $ git commit -a -m "Fix in a hurry"
157 $ git stash apply
158 ... continue hacking ...
159 ----------------------------------------------------------------
161 SEE ALSO
162 --------
163 linkgit:git-checkout[1],
164 linkgit:git-commit[1],
165 linkgit:git-reflog[1],
166 linkgit:git-reset[1]
168 AUTHOR
169 ------
170 Written by Nanako Shiraishi <nanako3@bluebottle.com>
174 Part of the linkgit:git[7] suite