3 # Copyright (c) 2005 Junio C Hamano.
6 USAGE='[--interactive | -i] [-v] [--force-rebase | -f] [--onto <newbase>] [<upstream>|--root] [<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-apply working files, use the
18 command 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
37 OK_TO_SKIP_PRE_REBASE=
39 When you have resolved this problem run \"git rebase --continue\".
40 If you would prefer to skip this patch, instead run \"git rebase --skip\".
41 To restore the original branch and stop rebasing run \"git rebase --abort\".
46 dotest="$GIT_DIR"/rebase-merge
54 test -n "$prev_head" || die "prev_head must be defined"
55 test -d "$dotest" || die "$dotest directory does not exist"
57 unmerged=$(git ls-files -u)
58 if test -n "$unmerged"
60 echo "You still have unmerged paths in your index"
61 echo "did you forget to use git add?"
65 cmt=`cat "$dotest/current"`
66 if ! git diff-index --quiet --ignore-submodules HEAD --
68 if ! git commit --no-verify -C "$cmt"
70 echo "Commit failed, please do not call \"git commit\""
71 echo "directly, but instead do one of the following: "
74 printf "Committed: %0${prec}d " $msgnum
76 printf "Already applied: %0${prec}d " $msgnum
78 git rev-list --pretty=oneline -1 "$cmt" | sed -e 's/^[^ ]* //'
80 prev_head=`git rev-parse HEAD^0`
81 # save the resulting commit so we can read-tree on it later
82 echo "$prev_head" > "$dotest/prev_head"
84 # onto the next patch:
85 msgnum=$(($msgnum + 1))
86 echo "$msgnum" >"$dotest/msgnum"
90 cmt="$(cat "$dotest/cmt.$1")"
91 echo "$cmt" > "$dotest/current"
92 hd=$(git rev-parse --verify HEAD)
93 cmt_name=$(git symbolic-ref HEAD 2> /dev/null || echo HEAD)
94 msgnum=$(cat "$dotest/msgnum")
95 end=$(cat "$dotest/end")
96 eval GITHEAD_$cmt='"${cmt_name##refs/heads/}~$(($end - $msgnum))"'
97 eval GITHEAD_$hd='$(cat "$dotest/onto_name")'
98 export GITHEAD_$cmt GITHEAD_$hd
99 git-merge-$strategy "$cmt^" -- "$hd" "$cmt"
103 unset GITHEAD_$cmt GITHEAD_$hd
111 echo "Strategy: $rv $strategy failed, try another" 1>&2
115 die "Unknown exit code ($rv) from command:" \
116 "git-merge-$strategy $cmt^ -- HEAD $cmt"
121 move_to_original_branch () {
122 test -z "$head_name" &&
123 head_name="$(cat "$dotest"/head-name)" &&
124 onto="$(cat "$dotest"/onto)" &&
125 orig_head="$(cat "$dotest"/orig-head)"
128 message="rebase finished: $head_name onto $onto"
129 git update-ref -m "$message" \
130 $head_name $(git rev-parse HEAD) $orig_head &&
131 git symbolic-ref HEAD $head_name ||
132 die "Could not move back to $head_name"
138 move_to_original_branch
148 interactive_rebase=explicit
151 -p|--preserve-merges)
152 interactive_rebase=implied
158 if [ "$interactive_rebase" = implied ]; then
163 test -n "$interactive_rebase" || test -f "$dotest"/interactive
166 run_pre_rebase_hook () {
167 if test -z "$OK_TO_SKIP_PRE_REBASE" &&
168 test -x "$GIT_DIR/hooks/pre-rebase"
170 "$GIT_DIR/hooks/pre-rebase" ${1+"$@"} || {
171 echo >&2 "The pre-rebase hook refused to rebase."
177 test -f "$GIT_DIR"/rebase-apply/applying &&
178 die 'It looks like git-am is in progress. Cannot rebase.'
180 is_interactive "$@" && exec git-rebase--interactive "$@"
184 test -d "$dotest" -o -d "$GIT_DIR"/rebase-apply || usage
185 test -d "$dotest" -o -f "$GIT_DIR"/rebase-apply/rebasing &&
186 die 'A rebase is in progress, try --continue, --skip or --abort.'
187 die "No arguments given and $GIT_DIR/rebase-apply already exists."
194 OK_TO_SKIP_PRE_REBASE=yes
197 test -d "$dotest" -o -d "$GIT_DIR"/rebase-apply ||
198 die "No rebase in progress?"
200 git diff-files --quiet --ignore-submodules || {
201 echo "You must edit all merge conflicts and then"
202 echo "mark them as resolved using git add"
207 prev_head=$(cat "$dotest/prev_head")
208 end=$(cat "$dotest/end")
209 msgnum=$(cat "$dotest/msgnum")
210 onto=$(cat "$dotest/onto")
212 while test "$msgnum" -le "$end"
220 head_name=$(cat "$GIT_DIR"/rebase-apply/head-name) &&
221 onto=$(cat "$GIT_DIR"/rebase-apply/onto) &&
222 orig_head=$(cat "$GIT_DIR"/rebase-apply/orig-head) &&
223 git am --resolved --3way --resolvemsg="$RESOLVEMSG" &&
224 move_to_original_branch
228 test -d "$dotest" -o -d "$GIT_DIR"/rebase-apply ||
229 die "No rebase in progress?"
231 git reset --hard HEAD || exit $?
235 prev_head=$(cat "$dotest/prev_head")
236 end=$(cat "$dotest/end")
237 msgnum=$(cat "$dotest/msgnum")
238 msgnum=$(($msgnum + 1))
239 onto=$(cat "$dotest/onto")
240 while test "$msgnum" -le "$end"
248 head_name=$(cat "$GIT_DIR"/rebase-apply/head-name) &&
249 onto=$(cat "$GIT_DIR"/rebase-apply/onto) &&
250 orig_head=$(cat "$GIT_DIR"/rebase-apply/orig-head) &&
251 git am -3 --skip --resolvemsg="$RESOLVEMSG" &&
252 move_to_original_branch
256 test -d "$dotest" -o -d "$GIT_DIR"/rebase-apply ||
257 die "No rebase in progress?"
262 move_to_original_branch
264 dotest="$GIT_DIR"/rebase-apply
265 move_to_original_branch
267 git reset --hard $(cat "$dotest/orig-head")
272 test 2 -le "$#" || usage
276 -M|-m|--m|--me|--mer|--merg|--merge)
279 -s=*|--s=*|--st=*|--str=*|--stra=*|--strat=*|--strate=*|\
280 --strateg=*|--strategy=*|\
281 -s|--s|--st|--str|--stra|--strat|--strate|--strateg|--strategy)
284 strategy=`expr "z$1" : 'z-[^=]*=\(.*\)'` ;;
297 git_am_opt="$git_am_opt $1"
299 --whitespace=fix|--whitespace=strip)
305 git_am_opt="$git_am_opt $1"
310 -f|--f|--fo|--for|--forc|force|--force-r|--force-re|--force-reb|--force-reba|--force_rebas|--force-rebase)
322 test $# -gt 2 && usage
324 # Make sure we do not have $GIT_DIR/rebase-apply
325 if test -z "$do_merge"
327 if mkdir "$GIT_DIR"/rebase-apply 2>/dev/null
329 rmdir "$GIT_DIR"/rebase-apply
332 It seems that I cannot create a rebase-apply directory, and
333 I wonder if you are in the middle of patch application or another
334 rebase. If that is not the case, please
335 rm -fr '"$GIT_DIR"'/rebase-apply
336 and run me again. I am stopping in case you still have something
343 die "previous rebase directory $dotest still exists." \
344 'Try git rebase (--continue | --abort | --skip)'
348 # The tree must be really really clean.
349 if ! git update-index --ignore-submodules --refresh; then
350 echo >&2 "cannot rebase: you have unstaged changes"
353 diff=$(git diff-index --cached --name-status -r --ignore-submodules HEAD --)
355 ?*) echo >&2 "cannot rebase: your index contains uncommitted changes"
361 if test -z "$rebase_root"
363 # The upstream head must be given. Make sure it is valid.
366 upstream=`git rev-parse --verify "${upstream_name}^0"` ||
367 die "invalid upstream $upstream_name"
369 upstream_arg="$upstream_name"
371 test -z "$newbase" && die "--root must be used with --onto"
375 upstream_arg="$root_flag"
378 # Make sure the branch to rebase onto is valid.
379 onto_name=${newbase-"$upstream_name"}
380 onto=$(git rev-parse --verify "${onto_name}^0") || exit
382 # If a hook exists, give it a chance to interrupt
383 run_pre_rebase_hook "$upstream_arg" "$@"
385 # If the branch to rebase is given, that is the branch we will rebase
386 # $branch_name -- branch being rebased, or HEAD (already detached)
387 # $orig_head -- commit object name of tip of the branch before rebasing
388 # $head_name -- refs/heads/<that-branch> or "detached HEAD"
392 # Is it "rebase other $branchname" or "rebase other $commit"?
396 if git show-ref --verify --quiet -- "refs/heads/$1" &&
397 branch=$(git rev-parse -q --verify "refs/heads/$1")
399 head_name="refs/heads/$1"
400 elif branch=$(git rev-parse -q --verify "$1")
402 head_name="detached HEAD"
408 # Do not need to switch branches, we are already on it.
409 if branch_name=`git symbolic-ref -q HEAD`
411 head_name=$branch_name
412 branch_name=`expr "z$branch_name" : 'zrefs/heads/\(.*\)'`
414 head_name="detached HEAD"
415 branch_name=HEAD ;# detached
417 branch=$(git rev-parse --verify "${branch_name}^0") || exit
422 # Now we are rebasing commits $upstream..$branch (or with --root,
423 # everything leading up to $branch) on top of $onto
425 # Check if we are already based on $onto with linear history,
426 # but this should be done only when upstream and onto are the same.
427 mb=$(git merge-base "$onto" "$branch")
428 if test "$upstream" = "$onto" && test "$mb" = "$onto" &&
430 ! (git rev-list --parents "$onto".."$branch" | grep " .* ") > /dev/null
432 if test -z "$force_rebase"
434 # Lazily switch to the target branch if needed...
435 test -z "$switch_to" || git checkout "$switch_to"
436 echo >&2 "Current branch $branch_name is up to date."
439 echo "Current branch $branch_name is up to date, rebase forced."
443 if test -n "$verbose"
445 echo "Changes from $mb to $onto:"
446 # We want color (if set), but no pager
447 GIT_PAGER='' git diff --stat --summary "$mb" "$onto"
450 # Detach HEAD and reset the tree
451 echo "First, rewinding head to replay your work on top of it..."
452 git checkout -q "$onto^0" || die "could not detach HEAD"
453 git update-ref ORIG_HEAD $branch
455 # If the $onto is a proper descendant of the tip of the branch, then
456 # we just fast forwarded.
457 if test "$mb" = "$branch"
459 echo >&2 "Fast-forwarded $branch_name to $onto_name."
460 move_to_original_branch
464 if test -n "$rebase_root"
466 revisions="$onto..$orig_head"
468 revisions="$upstream..$orig_head"
471 if test -z "$do_merge"
473 git format-patch -k --stdout --full-index --ignore-if-in-upstream \
474 $root_flag "$revisions" |
475 git am $git_am_opt --rebasing --resolvemsg="$RESOLVEMSG" &&
476 move_to_original_branch
478 test 0 != $ret -a -d "$GIT_DIR"/rebase-apply &&
479 echo $head_name > "$GIT_DIR"/rebase-apply/head-name &&
480 echo $onto > "$GIT_DIR"/rebase-apply/onto &&
481 echo $orig_head > "$GIT_DIR"/rebase-apply/orig-head
485 # start doing a rebase with git-merge
486 # this is rename-aware if the recursive (default) strategy is used
489 echo "$onto" > "$dotest/onto"
490 echo "$onto_name" > "$dotest/onto_name"
492 echo "$prev_head" > "$dotest/prev_head"
493 echo "$orig_head" > "$dotest/orig-head"
494 echo "$head_name" > "$dotest/head-name"
497 for cmt in `git rev-list --reverse --no-merges "$revisions"`
499 msgnum=$(($msgnum + 1))
500 echo "$cmt" > "$dotest/cmt.$msgnum"
503 echo 1 >"$dotest/msgnum"
504 echo $msgnum >"$dotest/end"
509 while test "$msgnum" -le "$end"