Merge branch 'bc/maint-1.6.1-branch-deleted-was' into maint
[git] / git-stash.sh
1 #!/bin/sh
2 # Copyright (c) 2007, Nanako Shiraishi
3
4 dashless=$(basename "$0" | sed -e 's/-/ /')
5 USAGE="list [<options>]
6    or: $dashless (show | drop | pop ) [<stash>]
7    or: $dashless apply [--index] [<stash>]
8    or: $dashless branch <branchname> [<stash>]
9    or: $dashless [save [--keep-index] [<message>]]
10    or: $dashless clear"
11
12 SUBDIRECTORY_OK=Yes
13 OPTIONS_SPEC=
14 . git-sh-setup
15 require_work_tree
16 cd_to_toplevel
17
18 TMP="$GIT_DIR/.git-stash.$$"
19 trap 'rm -f "$TMP-*"' 0
20
21 ref_stash=refs/stash
22
23 no_changes () {
24         git diff-index --quiet --cached HEAD --ignore-submodules -- &&
25         git diff-files --quiet --ignore-submodules
26 }
27
28 clear_stash () {
29         if test $# != 0
30         then
31                 die "git stash clear with parameters is unimplemented"
32         fi
33         if current=$(git rev-parse --verify $ref_stash 2>/dev/null)
34         then
35                 git update-ref -d $ref_stash $current
36         fi
37 }
38
39 create_stash () {
40         stash_msg="$1"
41
42         git update-index -q --refresh
43         if no_changes
44         then
45                 exit 0
46         fi
47
48         # state of the base commit
49         if b_commit=$(git rev-parse --verify HEAD)
50         then
51                 head=$(git log --no-color --abbrev-commit --pretty=oneline -n 1 HEAD --)
52         else
53                 die "You do not have the initial commit yet"
54         fi
55
56         if branch=$(git symbolic-ref -q HEAD)
57         then
58                 branch=${branch#refs/heads/}
59         else
60                 branch='(no branch)'
61         fi
62         msg=$(printf '%s: %s' "$branch" "$head")
63
64         # state of the index
65         i_tree=$(git write-tree) &&
66         i_commit=$(printf 'index on %s\n' "$msg" |
67                 git commit-tree $i_tree -p $b_commit) ||
68                 die "Cannot save the current index state"
69
70         # state of the working tree
71         w_tree=$( (
72                 rm -f "$TMP-index" &&
73                 cp -p ${GIT_INDEX_FILE-"$GIT_DIR/index"} "$TMP-index" &&
74                 GIT_INDEX_FILE="$TMP-index" &&
75                 export GIT_INDEX_FILE &&
76                 git read-tree -m $i_tree &&
77                 git add -u &&
78                 git write-tree &&
79                 rm -f "$TMP-index"
80         ) ) ||
81                 die "Cannot save the current worktree state"
82
83         # create the stash
84         if test -z "$stash_msg"
85         then
86                 stash_msg=$(printf 'WIP on %s' "$msg")
87         else
88                 stash_msg=$(printf 'On %s: %s' "$branch" "$stash_msg")
89         fi
90         w_commit=$(printf '%s\n' "$stash_msg" |
91                 git commit-tree $w_tree -p $b_commit -p $i_commit) ||
92                 die "Cannot record working tree state"
93 }
94
95 save_stash () {
96         keep_index=
97         case "$1" in
98         --keep-index)
99                 keep_index=t
100                 shift
101         esac
102
103         stash_msg="$*"
104
105         git update-index -q --refresh
106         if no_changes
107         then
108                 echo 'No local changes to save'
109                 exit 0
110         fi
111         test -f "$GIT_DIR/logs/$ref_stash" ||
112                 clear_stash || die "Cannot initialize stash"
113
114         create_stash "$stash_msg"
115
116         # Make sure the reflog for stash is kept.
117         : >>"$GIT_DIR/logs/$ref_stash"
118
119         git update-ref -m "$stash_msg" $ref_stash $w_commit ||
120                 die "Cannot save the current status"
121         printf 'Saved working directory and index state "%s"\n' "$stash_msg"
122
123         git reset --hard
124
125         if test -n "$keep_index" && test -n $i_tree
126         then
127                 git read-tree --reset -u $i_tree
128         fi
129 }
130
131 have_stash () {
132         git rev-parse --verify $ref_stash >/dev/null 2>&1
133 }
134
135 list_stash () {
136         have_stash || return 0
137         git log --no-color --pretty=oneline -g "$@" $ref_stash -- |
138         sed -n -e 's/^[.0-9a-f]* refs\///p'
139 }
140
141 show_stash () {
142         flags=$(git rev-parse --no-revs --flags "$@")
143         if test -z "$flags"
144         then
145                 flags=--stat
146         fi
147
148         w_commit=$(git rev-parse --verify --default $ref_stash "$@") &&
149         b_commit=$(git rev-parse --verify "$w_commit^") &&
150         git diff $flags $b_commit $w_commit
151 }
152
153 apply_stash () {
154         git update-index -q --refresh &&
155         git diff-files --quiet --ignore-submodules ||
156                 die 'Cannot apply to a dirty working tree, please stage your changes'
157
158         unstash_index=
159         case "$1" in
160         --index)
161                 unstash_index=t
162                 shift
163         esac
164
165         # current index state
166         c_tree=$(git write-tree) ||
167                 die 'Cannot apply a stash in the middle of a merge'
168
169         # stash records the work tree, and is a merge between the
170         # base commit (first parent) and the index tree (second parent).
171         s=$(git rev-parse --verify --default $ref_stash "$@") &&
172         w_tree=$(git rev-parse --verify "$s:") &&
173         b_tree=$(git rev-parse --verify "$s^1:") &&
174         i_tree=$(git rev-parse --verify "$s^2:") ||
175                 die "$*: no valid stashed state found"
176
177         unstashed_index_tree=
178         if test -n "$unstash_index" && test "$b_tree" != "$i_tree" &&
179                         test "$c_tree" != "$i_tree"
180         then
181                 git diff-tree --binary $s^2^..$s^2 | git apply --cached
182                 test $? -ne 0 &&
183                         die 'Conflicts in index. Try without --index.'
184                 unstashed_index_tree=$(git-write-tree) ||
185                         die 'Could not save index tree'
186                 git reset
187         fi
188
189         eval "
190                 GITHEAD_$w_tree='Stashed changes' &&
191                 GITHEAD_$c_tree='Updated upstream' &&
192                 GITHEAD_$b_tree='Version stash was based on' &&
193                 export GITHEAD_$w_tree GITHEAD_$c_tree GITHEAD_$b_tree
194         "
195
196         if git-merge-recursive $b_tree -- $c_tree $w_tree
197         then
198                 # No conflict
199                 if test -n "$unstashed_index_tree"
200                 then
201                         git read-tree "$unstashed_index_tree"
202                 else
203                         a="$TMP-added" &&
204                         git diff-index --cached --name-only --diff-filter=A $c_tree >"$a" &&
205                         git read-tree --reset $c_tree &&
206                         git update-index --add --stdin <"$a" ||
207                                 die "Cannot unstage modified files"
208                         rm -f "$a"
209                 fi
210                 git status || :
211         else
212                 # Merge conflict; keep the exit status from merge-recursive
213                 status=$?
214                 if test -n "$unstash_index"
215                 then
216                         echo >&2 'Index was not unstashed.'
217                 fi
218                 exit $status
219         fi
220 }
221
222 drop_stash () {
223         have_stash || die 'No stash entries to drop'
224
225         if test $# = 0
226         then
227                 set x "$ref_stash@{0}"
228                 shift
229         fi
230         # Verify supplied argument looks like a stash entry
231         s=$(git rev-parse --verify "$@") &&
232         git rev-parse --verify "$s:"   > /dev/null 2>&1 &&
233         git rev-parse --verify "$s^1:" > /dev/null 2>&1 &&
234         git rev-parse --verify "$s^2:" > /dev/null 2>&1 ||
235                 die "$*: not a valid stashed state"
236
237         git reflog delete --updateref --rewrite "$@" &&
238                 echo "Dropped $* ($s)" || die "$*: Could not drop stash entry"
239
240         # clear_stash if we just dropped the last stash entry
241         git rev-parse --verify "$ref_stash@{0}" > /dev/null 2>&1 || clear_stash
242 }
243
244 apply_to_branch () {
245         have_stash || die 'Nothing to apply'
246
247         test -n "$1" || die 'No branch name specified'
248         branch=$1
249
250         if test -z "$2"
251         then
252                 set x "$ref_stash@{0}"
253         fi
254         stash=$2
255
256         git-checkout -b $branch $stash^ &&
257         apply_stash --index $stash &&
258         drop_stash $stash
259 }
260
261 # Main command set
262 case "$1" in
263 list)
264         shift
265         if test $# = 0
266         then
267                 set x -n 10
268                 shift
269         fi
270         list_stash "$@"
271         ;;
272 show)
273         shift
274         show_stash "$@"
275         ;;
276 save)
277         shift
278         save_stash "$@"
279         ;;
280 apply)
281         shift
282         apply_stash "$@"
283         ;;
284 clear)
285         shift
286         clear_stash "$@"
287         ;;
288 create)
289         if test $# -gt 0 && test "$1" = create
290         then
291                 shift
292         fi
293         create_stash "$*" && echo "$w_commit"
294         ;;
295 drop)
296         shift
297         drop_stash "$@"
298         ;;
299 pop)
300         shift
301         if apply_stash "$@"
302         then
303                 test -z "$unstash_index" || shift
304                 drop_stash "$@"
305         fi
306         ;;
307 branch)
308         shift
309         apply_to_branch "$@"
310         ;;
311 *)
312         if test $# -eq 0
313         then
314                 save_stash &&
315                 echo '(To restore them type "git stash apply")'
316         else
317                 usage
318         fi
319         ;;
320 esac