1 #!/bin/sh
2 #
3 # Copyright (c) 2005 Junio C Hamano.
4 #
6 USAGE='[--interactive | -i] [-v] [--onto <newbase>] <upstream> [<branch>]'
7 LONG_USAGE='git-rebase replaces <branch> with a new branch of the
8 same name. When the --onto option is provided the new branch starts
9 out with a HEAD equal to <newbase>, otherwise it is equal to <upstream>
10 It then attempts to create a new commit for each commit from the original
11 <branch> that does not exist in the <upstream> branch.
13 It is possible that a merge failure will prevent this process from being
14 completely automatic. You will have to resolve any such merge failure
15 and run git rebase --continue. Another option is to bypass the commit
16 that caused the merge failure with git rebase --skip. To restore the
17 original <branch> and remove the .dotest working files, use the command
18 git rebase --abort instead.
20 Note that if <branch> is not specified on the command line, the
21 currently checked out branch is used. You must be in the top
22 directory of your project to start (or continue) a rebase.
24 Example: git-rebase master~1 topic
26 A---B---C topic A'\''--B'\''--C'\'' topic
27 / --> /
28 D---E---F---G master D---E---F---G master
29 '
31 SUBDIRECTORY_OK=Yes
32 . git-sh-setup
33 set_reflog_action rebase
34 require_work_tree
35 cd_to_toplevel
37 RESOLVEMSG="
38 When you have resolved this problem run \"git rebase --continue\".
39 If you would prefer to skip this patch, instead run \"git rebase --skip\".
40 To restore the original branch and stop rebasing run \"git rebase --abort\".
41 "
42 unset newbase
43 strategy=recursive
44 do_merge=
45 dotest=$GIT_DIR/.dotest-merge
46 prec=4
47 verbose=
48 git_am_opt=
50 continue_merge () {
51 test -n "$prev_head" || die "prev_head must be defined"
52 test -d "$dotest" || die "$dotest directory does not exist"
54 unmerged=$(git ls-files -u)
55 if test -n "$unmerged"
56 then
57 echo "You still have unmerged paths in your index"
58 echo "did you forget to use git add?"
59 die "$RESOLVEMSG"
60 fi
62 cmt=`cat $dotest/current`
63 if ! git diff-index --quiet HEAD
64 then
65 if ! git-commit -C "$cmt"
66 then
67 echo "Commit failed, please do not call \"git commit\""
68 echo "directly, but instead do one of the following: "
69 die "$RESOLVEMSG"
70 fi
71 printf "Committed: %0${prec}d " $msgnum
72 else
73 printf "Already applied: %0${prec}d " $msgnum
74 fi
75 git rev-list --pretty=oneline -1 "$cmt" | sed -e 's/^[^ ]* //'
77 prev_head=`git rev-parse HEAD^0`
78 # save the resulting commit so we can read-tree on it later
79 echo "$prev_head" > "$dotest/prev_head"
81 # onto the next patch:
82 msgnum=$(($msgnum + 1))
83 echo "$msgnum" >"$dotest/msgnum"
84 }
86 call_merge () {
87 cmt="$(cat $dotest/cmt.$1)"
88 echo "$cmt" > "$dotest/current"
89 hd=$(git rev-parse --verify HEAD)
90 cmt_name=$(git symbolic-ref HEAD)
91 msgnum=$(cat $dotest/msgnum)
92 end=$(cat $dotest/end)
93 eval GITHEAD_$cmt='"${cmt_name##refs/heads/}~$(($end - $msgnum))"'
94 eval GITHEAD_$hd='"$(cat $dotest/onto_name)"'
95 export GITHEAD_$cmt GITHEAD_$hd
96 git-merge-$strategy "$cmt^" -- "$hd" "$cmt"
97 rv=$?
98 case "$rv" in
99 0)
100 unset GITHEAD_$cmt GITHEAD_$hd
101 return
102 ;;
103 1)
104 git rerere
105 die "$RESOLVEMSG"
106 ;;
107 2)
108 echo "Strategy: $rv $strategy failed, try another" 1>&2
109 die "$RESOLVEMSG"
110 ;;
111 *)
112 die "Unknown exit code ($rv) from command:" \
113 "git-merge-$strategy $cmt^ -- HEAD $cmt"
114 ;;
115 esac
116 }
118 finish_rb_merge () {
119 rm -r "$dotest"
120 echo "All done."
121 }
123 is_interactive () {
124 test -f "$dotest"/interactive ||
125 while case $#,"$1" in 0,|*,-i|*,--interactive) break ;; esac
126 do
127 shift
128 done && test -n "$1"
129 }
131 is_interactive "$@" && exec git-rebase--interactive "$@"
133 while case "$#" in 0) break ;; esac
134 do
135 case "$1" in
136 --continue)
137 git diff-files --quiet || {
138 echo "You must edit all merge conflicts and then"
139 echo "mark them as resolved using git add"
140 exit 1
141 }
142 if test -d "$dotest"
143 then
144 prev_head="`cat $dotest/prev_head`"
145 end="`cat $dotest/end`"
146 msgnum="`cat $dotest/msgnum`"
147 onto="`cat $dotest/onto`"
148 continue_merge
149 while test "$msgnum" -le "$end"
150 do
151 call_merge "$msgnum"
152 continue_merge
153 done
154 finish_rb_merge
155 exit
156 fi
157 git am --resolved --3way --resolvemsg="$RESOLVEMSG"
158 exit
159 ;;
160 --skip)
161 if test -d "$dotest"
162 then
163 git rerere clear
164 prev_head="`cat $dotest/prev_head`"
165 end="`cat $dotest/end`"
166 msgnum="`cat $dotest/msgnum`"
167 msgnum=$(($msgnum + 1))
168 onto="`cat $dotest/onto`"
169 while test "$msgnum" -le "$end"
170 do
171 call_merge "$msgnum"
172 continue_merge
173 done
174 finish_rb_merge
175 exit
176 fi
177 git am -3 --skip --resolvemsg="$RESOLVEMSG"
178 exit
179 ;;
180 --abort)
181 git rerere clear
182 if test -d "$dotest"
183 then
184 rm -r "$dotest"
185 elif test -d .dotest
186 then
187 rm -r .dotest
188 else
189 die "No rebase in progress?"
190 fi
191 git reset --hard ORIG_HEAD
192 exit
193 ;;
194 --onto)
195 test 2 -le "$#" || usage
196 newbase="$2"
197 shift
198 ;;
199 -M|-m|--m|--me|--mer|--merg|--merge)
200 do_merge=t
201 ;;
202 -s=*|--s=*|--st=*|--str=*|--stra=*|--strat=*|--strate=*|\
203 --strateg=*|--strategy=*|\
204 -s|--s|--st|--str|--stra|--strat|--strate|--strateg|--strategy)
205 case "$#,$1" in
206 *,*=*)
207 strategy=`expr "z$1" : 'z-[^=]*=\(.*\)'` ;;
208 1,*)
209 usage ;;
210 *)
211 strategy="$2"
212 shift ;;
213 esac
214 do_merge=t
215 ;;
216 -v|--verbose)
217 verbose=t
218 ;;
219 --whitespace=*)
220 git_am_opt="$git_am_opt $1"
221 ;;
222 -C*)
223 git_am_opt="$git_am_opt $1"
224 shift
225 ;;
226 -*)
227 usage
228 ;;
229 *)
230 break
231 ;;
232 esac
233 shift
234 done
236 # Make sure we do not have .dotest
237 if test -z "$do_merge"
238 then
239 if mkdir .dotest
240 then
241 rmdir .dotest
242 else
243 echo >&2 '
244 It seems that I cannot create a .dotest directory, and I wonder if you
245 are in the middle of patch application or another rebase. If that is not
246 the case, please rm -fr .dotest and run me again. I am stopping in case
247 you still have something valuable there.'
248 exit 1
249 fi
250 else
251 if test -d "$dotest"
252 then
253 die "previous dotest directory $dotest still exists." \
254 'try git-rebase < --continue | --abort >'
255 fi
256 fi
258 # The tree must be really really clean.
259 git update-index --refresh || exit
260 diff=$(git diff-index --cached --name-status -r HEAD)
261 case "$diff" in
262 ?*) echo "cannot rebase: your index is not up-to-date"
263 echo "$diff"
264 exit 1
265 ;;
266 esac
268 # The upstream head must be given. Make sure it is valid.
269 upstream_name="$1"
270 upstream=`git rev-parse --verify "${upstream_name}^0"` ||
271 die "invalid upstream $upstream_name"
273 # Make sure the branch to rebase onto is valid.
274 onto_name=${newbase-"$upstream_name"}
275 onto=$(git rev-parse --verify "${onto_name}^0") || exit
277 # If a hook exists, give it a chance to interrupt
278 if test -x "$GIT_DIR/hooks/pre-rebase"
279 then
280 "$GIT_DIR/hooks/pre-rebase" ${1+"$@"} || {
281 echo >&2 "The pre-rebase hook refused to rebase."
282 exit 1
283 }
284 fi
286 # If the branch to rebase is given, first switch to it.
287 case "$#" in
288 2)
289 branch_name="$2"
290 git-checkout "$2" || usage
291 ;;
292 *)
293 if branch_name=`git symbolic-ref -q HEAD`
294 then
295 branch_name=`expr "z$branch_name" : 'zrefs/heads/\(.*\)'`
296 else
297 branch_name=HEAD ;# detached
298 fi
299 ;;
300 esac
301 branch=$(git rev-parse --verify "${branch_name}^0") || exit
303 # Now we are rebasing commits $upstream..$branch on top of $onto
305 # Check if we are already based on $onto with linear history,
306 # but this should be done only when upstream and onto are the same.
307 mb=$(git merge-base "$onto" "$branch")
308 if test "$upstream" = "$onto" && test "$mb" = "$onto" &&
309 # linear history?
310 ! git rev-list --parents "$onto".."$branch" | grep " .* " > /dev/null
311 then
312 echo >&2 "Current branch $branch_name is up to date."
313 exit 0
314 fi
316 if test -n "$verbose"
317 then
318 echo "Changes from $mb to $onto:"
319 # We want color (if set), but no pager
320 GIT_PAGER='' git diff --stat --summary "$mb" "$onto"
321 fi
323 # Rewind the head to "$onto"; this saves our current head in ORIG_HEAD.
324 echo "First, rewinding head to replay your work on top of it..."
325 git-reset --hard "$onto"
327 # If the $onto is a proper descendant of the tip of the branch, then
328 # we just fast forwarded.
329 if test "$mb" = "$branch"
330 then
331 echo >&2 "Fast-forwarded $branch_name to $onto_name."
332 exit 0
333 fi
335 if test -z "$do_merge"
336 then
337 git format-patch -k --stdout --full-index --ignore-if-in-upstream "$upstream"..ORIG_HEAD |
338 git am $git_am_opt --binary -3 -k --resolvemsg="$RESOLVEMSG"
339 exit $?
340 fi
342 # start doing a rebase with git-merge
343 # this is rename-aware if the recursive (default) strategy is used
345 mkdir -p "$dotest"
346 echo "$onto" > "$dotest/onto"
347 echo "$onto_name" > "$dotest/onto_name"
348 prev_head=`git rev-parse HEAD^0`
349 echo "$prev_head" > "$dotest/prev_head"
351 msgnum=0
352 for cmt in `git rev-list --reverse --no-merges "$upstream"..ORIG_HEAD`
353 do
354 msgnum=$(($msgnum + 1))
355 echo "$cmt" > "$dotest/cmt.$msgnum"
356 done
358 echo 1 >"$dotest/msgnum"
359 echo $msgnum >"$dotest/end"
361 end=$msgnum
362 msgnum=1
364 while test "$msgnum" -le "$end"
365 do
366 call_merge "$msgnum"
367 continue_merge
368 done
370 finish_rb_merge