3 # Copyright (c) 2005 Junio C Hamano.
6 USAGE='[--interactive | -i] [-v] [--force-rebase | -f] [--onto <newbase>] [<upstream>|--root] [<branch>] [--quiet | -q]'
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
39 OK_TO_SKIP_PRE_REBASE=
41 When you have resolved this problem run \"git rebase --continue\".
42 If you would prefer to skip this patch, instead run \"git rebase --skip\".
43 To restore the original branch and stop rebasing run \"git rebase --abort\".
48 dotest="$GIT_DIR"/rebase-merge
51 diffstat=$(git config --bool rebase.stat)
57 test -n "$prev_head" || die "prev_head must be defined"
58 test -d "$dotest" || die "$dotest directory does not exist"
60 unmerged=$(git ls-files -u)
61 if test -n "$unmerged"
63 echo "You still have unmerged paths in your index"
64 echo "did you forget to use git add?"
68 cmt=`cat "$dotest/current"`
69 if ! git diff-index --quiet --ignore-submodules HEAD --
71 if ! git commit --no-verify -C "$cmt"
73 echo "Commit failed, please do not call \"git commit\""
74 echo "directly, but instead do one of the following: "
77 if test -z "$GIT_QUIET"
79 printf "Committed: %0${prec}d " $msgnum
82 if test -z "$GIT_QUIET"
84 printf "Already applied: %0${prec}d " $msgnum
87 if test -z "$GIT_QUIET"
89 git rev-list --pretty=oneline -1 "$cmt" | sed -e 's/^[^ ]* //'
92 prev_head=`git rev-parse HEAD^0`
93 # save the resulting commit so we can read-tree on it later
94 echo "$prev_head" > "$dotest/prev_head"
96 # onto the next patch:
97 msgnum=$(($msgnum + 1))
98 echo "$msgnum" >"$dotest/msgnum"
102 cmt="$(cat "$dotest/cmt.$1")"
103 echo "$cmt" > "$dotest/current"
104 hd=$(git rev-parse --verify HEAD)
105 cmt_name=$(git symbolic-ref HEAD 2> /dev/null || echo HEAD)
106 msgnum=$(cat "$dotest/msgnum")
107 end=$(cat "$dotest/end")
108 eval GITHEAD_$cmt='"${cmt_name##refs/heads/}~$(($end - $msgnum))"'
109 eval GITHEAD_$hd='$(cat "$dotest/onto_name")'
110 export GITHEAD_$cmt GITHEAD_$hd
111 if test -n "$GIT_QUIET"
113 export GIT_MERGE_VERBOSITY=1
115 git-merge-$strategy "$cmt^" -- "$hd" "$cmt"
119 unset GITHEAD_$cmt GITHEAD_$hd
127 echo "Strategy: $rv $strategy failed, try another" 1>&2
131 die "Unknown exit code ($rv) from command:" \
132 "git-merge-$strategy $cmt^ -- HEAD $cmt"
137 move_to_original_branch () {
138 test -z "$head_name" &&
139 head_name="$(cat "$dotest"/head-name)" &&
140 onto="$(cat "$dotest"/onto)" &&
141 orig_head="$(cat "$dotest"/orig-head)"
144 message="rebase finished: $head_name onto $onto"
145 git update-ref -m "$message" \
146 $head_name $(git rev-parse HEAD) $orig_head &&
147 git symbolic-ref HEAD $head_name ||
148 die "Could not move back to $head_name"
154 move_to_original_branch
164 interactive_rebase=explicit
167 -p|--preserve-merges)
168 interactive_rebase=implied
174 if [ "$interactive_rebase" = implied ]; then
179 test -n "$interactive_rebase" || test -f "$dotest"/interactive
182 run_pre_rebase_hook () {
183 if test -z "$OK_TO_SKIP_PRE_REBASE" &&
184 test -x "$GIT_DIR/hooks/pre-rebase"
186 "$GIT_DIR/hooks/pre-rebase" ${1+"$@"} ||
187 die "The pre-rebase hook refused to rebase."
191 test -f "$GIT_DIR"/rebase-apply/applying &&
192 die 'It looks like git-am is in progress. Cannot rebase.'
194 is_interactive "$@" && exec git-rebase--interactive "$@"
198 test -d "$dotest" -o -d "$GIT_DIR"/rebase-apply || usage
199 test -d "$dotest" -o -f "$GIT_DIR"/rebase-apply/rebasing &&
200 die 'A rebase is in progress, try --continue, --skip or --abort.'
201 die "No arguments given and $GIT_DIR/rebase-apply already exists."
208 OK_TO_SKIP_PRE_REBASE=yes
211 test -d "$dotest" -o -d "$GIT_DIR"/rebase-apply ||
212 die "No rebase in progress?"
214 git diff-files --quiet --ignore-submodules || {
215 echo "You must edit all merge conflicts and then"
216 echo "mark them as resolved using git add"
221 prev_head=$(cat "$dotest/prev_head")
222 end=$(cat "$dotest/end")
223 msgnum=$(cat "$dotest/msgnum")
224 onto=$(cat "$dotest/onto")
225 GIT_QUIET=$(cat "$dotest/quiet")
227 while test "$msgnum" -le "$end"
235 head_name=$(cat "$GIT_DIR"/rebase-apply/head-name) &&
236 onto=$(cat "$GIT_DIR"/rebase-apply/onto) &&
237 orig_head=$(cat "$GIT_DIR"/rebase-apply/orig-head) &&
238 GIT_QUIET=$(cat "$GIT_DIR"/rebase-apply/quiet)
239 git am --resolved --3way --resolvemsg="$RESOLVEMSG" &&
240 move_to_original_branch
244 test -d "$dotest" -o -d "$GIT_DIR"/rebase-apply ||
245 die "No rebase in progress?"
247 git reset --hard HEAD || exit $?
251 prev_head=$(cat "$dotest/prev_head")
252 end=$(cat "$dotest/end")
253 msgnum=$(cat "$dotest/msgnum")
254 msgnum=$(($msgnum + 1))
255 onto=$(cat "$dotest/onto")
256 GIT_QUIET=$(cat "$dotest/quiet")
257 while test "$msgnum" -le "$end"
265 head_name=$(cat "$GIT_DIR"/rebase-apply/head-name) &&
266 onto=$(cat "$GIT_DIR"/rebase-apply/onto) &&
267 orig_head=$(cat "$GIT_DIR"/rebase-apply/orig-head) &&
268 GIT_QUIET=$(cat "$GIT_DIR"/rebase-apply/quiet)
269 git am -3 --skip --resolvemsg="$RESOLVEMSG" &&
270 move_to_original_branch
274 test -d "$dotest" -o -d "$GIT_DIR"/rebase-apply ||
275 die "No rebase in progress?"
280 GIT_QUIET=$(cat "$dotest/quiet")
281 move_to_original_branch
283 dotest="$GIT_DIR"/rebase-apply
284 GIT_QUIET=$(cat "$dotest/quiet")
285 move_to_original_branch
287 git reset --hard $(cat "$dotest/orig-head")
292 test 2 -le "$#" || usage
296 -M|-m|--m|--me|--mer|--merg|--merge)
299 -s=*|--s=*|--st=*|--str=*|--stra=*|--strat=*|--strate=*|\
300 --strateg=*|--strategy=*|\
301 -s|--s|--st|--str|--stra|--strat|--strate|--strateg|--strategy)
304 strategy=`expr "z$1" : 'z-[^=]*=\(.*\)'` ;;
326 git_am_opt="$git_am_opt -q"
331 git_am_opt="$git_am_opt $1"
333 --whitespace=fix|--whitespace=strip)
339 git_am_opt="$git_am_opt $1"
341 --committer-date-is-author-date|--ignore-date)
342 git_am_opt="$git_am_opt $1"
346 git_am_opt="$git_am_opt $1"
351 -f|--f|--fo|--for|--forc|force|--force-r|--force-re|--force-reb|--force-reba|--force-rebas|--force-rebase)
363 test $# -gt 2 && usage
365 # Make sure we do not have $GIT_DIR/rebase-apply
366 if test -z "$do_merge"
368 if mkdir "$GIT_DIR"/rebase-apply 2>/dev/null
370 rmdir "$GIT_DIR"/rebase-apply
373 It seems that I cannot create a rebase-apply directory, and
374 I wonder if you are in the middle of patch application or another
375 rebase. If that is not the case, please
376 rm -fr '"$GIT_DIR"'/rebase-apply
377 and run me again. I am stopping in case you still have something
384 die "previous rebase directory $dotest still exists." \
385 'Try git rebase (--continue | --abort | --skip)'
389 # The tree must be really really clean.
390 if ! git update-index --ignore-submodules --refresh > /dev/null; then
391 echo >&2 "cannot rebase: you have unstaged changes"
392 git diff-files --name-status -r --ignore-submodules -- >&2
395 diff=$(git diff-index --cached --name-status -r --ignore-submodules HEAD --)
397 ?*) echo >&2 "cannot rebase: your index contains uncommitted changes"
403 if test -z "$rebase_root"
405 # The upstream head must be given. Make sure it is valid.
408 upstream=`git rev-parse --verify "${upstream_name}^0"` ||
409 die "invalid upstream $upstream_name"
411 upstream_arg="$upstream_name"
413 test -z "$newbase" && die "--root must be used with --onto"
417 upstream_arg="$root_flag"
420 # Make sure the branch to rebase onto is valid.
421 onto_name=${newbase-"$upstream_name"}
424 if left=${onto_name%...*} right=${onto_name#*...} &&
425 onto=$(git merge-base --all ${left:-HEAD} ${right:-HEAD})
429 die "$onto_name: there are more than one merge bases"
432 die "$onto_name: there is no merge base"
436 die "$onto_name: there is no merge base"
440 onto=$(git rev-parse --verify "${onto_name}^0") || exit
444 # If a hook exists, give it a chance to interrupt
445 run_pre_rebase_hook "$upstream_arg" "$@"
447 # If the branch to rebase is given, that is the branch we will rebase
448 # $branch_name -- branch being rebased, or HEAD (already detached)
449 # $orig_head -- commit object name of tip of the branch before rebasing
450 # $head_name -- refs/heads/<that-branch> or "detached HEAD"
454 # Is it "rebase other $branchname" or "rebase other $commit"?
458 if git show-ref --verify --quiet -- "refs/heads/$1" &&
459 branch=$(git rev-parse -q --verify "refs/heads/$1")
461 head_name="refs/heads/$1"
462 elif branch=$(git rev-parse -q --verify "$1")
464 head_name="detached HEAD"
470 # Do not need to switch branches, we are already on it.
471 if branch_name=`git symbolic-ref -q HEAD`
473 head_name=$branch_name
474 branch_name=`expr "z$branch_name" : 'zrefs/heads/\(.*\)'`
476 head_name="detached HEAD"
477 branch_name=HEAD ;# detached
479 branch=$(git rev-parse --verify "${branch_name}^0") || exit
484 # Now we are rebasing commits $upstream..$branch (or with --root,
485 # everything leading up to $branch) on top of $onto
487 # Check if we are already based on $onto with linear history,
488 # but this should be done only when upstream and onto are the same.
489 mb=$(git merge-base "$onto" "$branch")
490 if test "$upstream" = "$onto" && test "$mb" = "$onto" &&
492 ! (git rev-list --parents "$onto".."$branch" | sane_grep " .* ") > /dev/null
494 if test -z "$force_rebase"
496 # Lazily switch to the target branch if needed...
497 test -z "$switch_to" || git checkout "$switch_to"
498 say "Current branch $branch_name is up to date."
501 say "Current branch $branch_name is up to date, rebase forced."
505 # Detach HEAD and reset the tree
506 say "First, rewinding head to replay your work on top of it..."
507 git checkout -q "$onto^0" || die "could not detach HEAD"
508 git update-ref ORIG_HEAD $branch
510 if test -n "$diffstat"
512 if test -n "$verbose"
514 echo "Changes from $mb to $onto:"
516 # We want color (if set), but no pager
517 GIT_PAGER='' git diff --stat --summary "$mb" "$onto"
520 # If the $onto is a proper descendant of the tip of the branch, then
521 # we just fast-forwarded.
522 if test "$mb" = "$branch"
524 say "Fast-forwarded $branch_name to $onto_name."
525 move_to_original_branch
529 if test -n "$rebase_root"
531 revisions="$onto..$orig_head"
533 revisions="$upstream..$orig_head"
536 if test -z "$do_merge"
538 git format-patch -k --stdout --full-index --ignore-if-in-upstream \
539 $root_flag "$revisions" |
540 git am $git_am_opt --rebasing --resolvemsg="$RESOLVEMSG" &&
541 move_to_original_branch
543 test 0 != $ret -a -d "$GIT_DIR"/rebase-apply &&
544 echo $head_name > "$GIT_DIR"/rebase-apply/head-name &&
545 echo $onto > "$GIT_DIR"/rebase-apply/onto &&
546 echo $orig_head > "$GIT_DIR"/rebase-apply/orig-head &&
547 echo "$GIT_QUIET" > "$GIT_DIR"/rebase-apply/quiet
551 # start doing a rebase with git-merge
552 # this is rename-aware if the recursive (default) strategy is used
555 echo "$onto" > "$dotest/onto"
556 echo "$onto_name" > "$dotest/onto_name"
558 echo "$prev_head" > "$dotest/prev_head"
559 echo "$orig_head" > "$dotest/orig-head"
560 echo "$head_name" > "$dotest/head-name"
561 echo "$GIT_QUIET" > "$dotest/quiet"
564 for cmt in `git rev-list --reverse --no-merges "$revisions"`
566 msgnum=$(($msgnum + 1))
567 echo "$cmt" > "$dotest/cmt.$msgnum"
570 echo 1 >"$dotest/msgnum"
571 echo $msgnum >"$dotest/end"
576 while test "$msgnum" -le "$end"