3 # Copyright (c) 2005 Junio C Hamano.
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 .git/rebase 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.
23 Example: git-rebase master~1 topic
25 A---B---C topic A'\''--B'\''--C'\'' topic
27 D---E---F---G master D---E---F---G master
33 set_reflog_action rebase
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\".
45 dotest="$GIT_DIR"/rebase-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"
57 echo "You still have unmerged paths in your index"
58 echo "did you forget to use git add?"
62 cmt=`cat "$dotest/current"`
63 if ! git diff-index --quiet --ignore-submodules HEAD --
65 if ! git commit --no-verify -C "$cmt"
67 echo "Commit failed, please do not call \"git commit\""
68 echo "directly, but instead do one of the following: "
71 printf "Committed: %0${prec}d " $msgnum
73 printf "Already applied: %0${prec}d " $msgnum
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"
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 2> /dev/null || echo 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"
100 unset GITHEAD_$cmt GITHEAD_$hd
108 echo "Strategy: $rv $strategy failed, try another" 1>&2
112 die "Unknown exit code ($rv) from command:" \
113 "git-merge-$strategy $cmt^ -- HEAD $cmt"
118 move_to_original_branch () {
119 test -z "$head_name" &&
120 head_name="$(cat "$dotest"/head-name)" &&
121 onto="$(cat "$dotest"/onto)" &&
122 orig_head="$(cat "$dotest"/orig-head)"
125 message="rebase finished: $head_name onto $onto"
126 git update-ref -m "$message" \
127 $head_name $(git rev-parse HEAD) $orig_head &&
128 git symbolic-ref HEAD $head_name ||
129 die "Could not move back to $head_name"
135 move_to_original_branch
141 test -f "$dotest"/interactive ||
142 while :; do case $#,"$1" in 0,|*,-i|*,--interactive) break ;; esac
147 is_interactive "$@" && exec git-rebase--interactive "$@"
153 test -d "$dotest" -o -d "$GIT_DIR"/rebase ||
154 die "No rebase in progress?"
156 git diff-files --quiet --ignore-submodules || {
157 echo "You must edit all merge conflicts and then"
158 echo "mark them as resolved using git add"
163 prev_head=$(cat "$dotest/prev_head")
164 end=$(cat "$dotest/end")
165 msgnum=$(cat "$dotest/msgnum")
166 onto=$(cat "$dotest/onto")
168 while test "$msgnum" -le "$end"
176 head_name=$(cat "$GIT_DIR"/rebase/head-name) &&
177 onto=$(cat "$GIT_DIR"/rebase/onto) &&
178 orig_head=$(cat "$GIT_DIR"/rebase/orig-head) &&
179 git am --resolved --3way --resolvemsg="$RESOLVEMSG" &&
180 move_to_original_branch
184 test -d "$dotest" -o -d "$GIT_DIR"/rebase ||
185 die "No rebase in progress?"
187 git reset --hard HEAD || exit $?
191 prev_head=$(cat "$dotest/prev_head")
192 end=$(cat "$dotest/end")
193 msgnum=$(cat "$dotest/msgnum")
194 msgnum=$(($msgnum + 1))
195 onto=$(cat "$dotest/onto")
196 while test "$msgnum" -le "$end"
204 head_name=$(cat "$GIT_DIR"/rebase/head-name) &&
205 onto=$(cat "$GIT_DIR"/rebase/onto) &&
206 orig_head=$(cat "$GIT_DIR"/rebase/orig-head) &&
207 git am -3 --skip --resolvemsg="$RESOLVEMSG" &&
208 move_to_original_branch
212 test -d "$dotest" -o -d "$GIT_DIR"/rebase ||
213 die "No rebase in progress?"
218 move_to_original_branch
220 dotest="$GIT_DIR"/rebase
221 move_to_original_branch
223 git reset --hard $(cat "$dotest/orig-head")
228 test 2 -le "$#" || usage
232 -M|-m|--m|--me|--mer|--merg|--merge)
235 -s=*|--s=*|--st=*|--str=*|--stra=*|--strat=*|--strate=*|\
236 --strateg=*|--strategy=*|\
237 -s|--s|--st|--str|--stra|--strat|--strate|--strateg|--strategy)
240 strategy=`expr "z$1" : 'z-[^=]*=\(.*\)'` ;;
253 git_am_opt="$git_am_opt $1"
256 git_am_opt="$git_am_opt $1"
268 # Make sure we do not have $GIT_DIR/rebase
269 if test -z "$do_merge"
271 if mkdir "$GIT_DIR"/rebase
273 rmdir "$GIT_DIR"/rebase
276 It seems that I cannot create a '"$GIT_DIR"'/rebase directory, and I wonder if you
277 are in the middle of patch application or another rebase. If that is not
278 the case, please rm -fr '"$GIT_DIR"'/rebase and run me again. I am stopping in case
279 you still have something valuable there.'
285 die "previous rebase directory $dotest still exists." \
286 'try git-rebase < --continue | --abort >'
290 # The tree must be really really clean.
291 git update-index --ignore-submodules --refresh || exit
292 diff=$(git diff-index --cached --name-status -r --ignore-submodules HEAD --)
294 ?*) echo "cannot rebase: your index is not up-to-date"
300 # The upstream head must be given. Make sure it is valid.
302 upstream=`git rev-parse --verify "${upstream_name}^0"` ||
303 die "invalid upstream $upstream_name"
305 # Make sure the branch to rebase onto is valid.
306 onto_name=${newbase-"$upstream_name"}
307 onto=$(git rev-parse --verify "${onto_name}^0") || exit
309 # If a hook exists, give it a chance to interrupt
310 if test -x "$GIT_DIR/hooks/pre-rebase"
312 "$GIT_DIR/hooks/pre-rebase" ${1+"$@"} || {
313 echo >&2 "The pre-rebase hook refused to rebase."
318 # If the branch to rebase is given, that is the branch we will rebase
319 # $branch_name -- branch being rebased, or HEAD (already detached)
320 # $orig_head -- commit object name of tip of the branch before rebasing
321 # $head_name -- refs/heads/<that-branch> or "detached HEAD"
325 # Is it "rebase other $branchname" or "rebase other $commit"?
329 if git show-ref --verify --quiet -- "refs/heads/$2" &&
330 branch=$(git rev-parse --verify "refs/heads/$2" 2>/dev/null)
332 head_name="refs/heads/$2"
333 elif branch=$(git rev-parse --verify "$2" 2>/dev/null)
335 head_name="detached HEAD"
341 # Do not need to switch branches, we are already on it.
342 if branch_name=`git symbolic-ref -q HEAD`
344 head_name=$branch_name
345 branch_name=`expr "z$branch_name" : 'zrefs/heads/\(.*\)'`
347 head_name="detached HEAD"
348 branch_name=HEAD ;# detached
350 branch=$(git rev-parse --verify "${branch_name}^0") || exit
355 # Now we are rebasing commits $upstream..$branch on top of $onto
357 # Check if we are already based on $onto with linear history,
358 # but this should be done only when upstream and onto are the same.
359 mb=$(git merge-base "$onto" "$branch")
360 if test "$upstream" = "$onto" && test "$mb" = "$onto" &&
362 ! (git rev-list --parents "$onto".."$branch" | grep " .* ") > /dev/null
364 # Lazily switch to the target branch if needed...
365 test -z "$switch_to" || git checkout "$switch_to"
366 echo >&2 "Current branch $branch_name is up to date."
370 if test -n "$verbose"
372 echo "Changes from $mb to $onto:"
373 # We want color (if set), but no pager
374 GIT_PAGER='' git diff --stat --summary "$mb" "$onto"
377 # Detach HEAD and reset the tree
378 echo "First, rewinding head to replay your work on top of it..."
379 git checkout -q "$onto^0" || die "could not detach HEAD"
380 git update-ref ORIG_HEAD $branch
382 # If the $onto is a proper descendant of the tip of the branch, then
383 # we just fast forwarded.
384 if test "$mb" = "$branch"
386 echo >&2 "Fast-forwarded $branch_name to $onto_name."
387 move_to_original_branch
391 if test -z "$do_merge"
393 git format-patch -k --stdout --full-index --ignore-if-in-upstream \
394 "$upstream..$orig_head" |
395 git am $git_am_opt --rebasing --resolvemsg="$RESOLVEMSG" &&
396 move_to_original_branch
398 test 0 != $ret -a -d "$GIT_DIR"/rebase &&
399 echo $head_name > "$GIT_DIR"/rebase/head-name &&
400 echo $onto > "$GIT_DIR"/rebase/onto &&
401 echo $orig_head > "$GIT_DIR"/rebase/orig-head
405 # start doing a rebase with git-merge
406 # this is rename-aware if the recursive (default) strategy is used
409 echo "$onto" > "$dotest/onto"
410 echo "$onto_name" > "$dotest/onto_name"
412 echo "$prev_head" > "$dotest/prev_head"
413 echo "$orig_head" > "$dotest/orig-head"
414 echo "$head_name" > "$dotest/head-name"
417 for cmt in `git rev-list --reverse --no-merges "$upstream..$orig_head"`
419 msgnum=$(($msgnum + 1))
420 echo "$cmt" > "$dotest/cmt.$msgnum"
423 echo 1 >"$dotest/msgnum"
424 echo $msgnum >"$dotest/end"
429 while test "$msgnum" -le "$end"