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
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
49 diffstat=$(git config --bool rebase.stat)
55 test -n "$prev_head" || die "prev_head must be defined"
56 test -d "$dotest" || die "$dotest directory does not exist"
58 unmerged=$(git ls-files -u)
59 if test -n "$unmerged"
61 echo "You still have unmerged paths in your index"
62 echo "did you forget to use git add?"
66 cmt=`cat "$dotest/current"`
67 if ! git diff-index --quiet --ignore-submodules HEAD --
69 if ! git commit --no-verify -C "$cmt"
71 echo "Commit failed, please do not call \"git commit\""
72 echo "directly, but instead do one of the following: "
75 if test -z "$GIT_QUIET"
77 printf "Committed: %0${prec}d " $msgnum
80 if test -z "$GIT_QUIET"
82 printf "Already applied: %0${prec}d " $msgnum
85 if test -z "$GIT_QUIET"
87 git rev-list --pretty=oneline -1 "$cmt" | sed -e 's/^[^ ]* //'
90 prev_head=`git rev-parse HEAD^0`
91 # save the resulting commit so we can read-tree on it later
92 echo "$prev_head" > "$dotest/prev_head"
94 # onto the next patch:
95 msgnum=$(($msgnum + 1))
96 echo "$msgnum" >"$dotest/msgnum"
100 cmt="$(cat "$dotest/cmt.$1")"
101 echo "$cmt" > "$dotest/current"
102 hd=$(git rev-parse --verify HEAD)
103 cmt_name=$(git symbolic-ref HEAD 2> /dev/null || echo HEAD)
104 msgnum=$(cat "$dotest/msgnum")
105 end=$(cat "$dotest/end")
106 eval GITHEAD_$cmt='"${cmt_name##refs/heads/}~$(($end - $msgnum))"'
107 eval GITHEAD_$hd='$(cat "$dotest/onto_name")'
108 export GITHEAD_$cmt GITHEAD_$hd
109 if test -n "$GIT_QUIET"
111 export GIT_MERGE_VERBOSITY=1
113 git-merge-$strategy "$cmt^" -- "$hd" "$cmt"
117 unset GITHEAD_$cmt GITHEAD_$hd
125 echo "Strategy: $rv $strategy failed, try another" 1>&2
129 die "Unknown exit code ($rv) from command:" \
130 "git-merge-$strategy $cmt^ -- HEAD $cmt"
135 move_to_original_branch () {
136 test -z "$head_name" &&
137 head_name="$(cat "$dotest"/head-name)" &&
138 onto="$(cat "$dotest"/onto)" &&
139 orig_head="$(cat "$dotest"/orig-head)"
142 message="rebase finished: $head_name onto $onto"
143 git update-ref -m "$message" \
144 $head_name $(git rev-parse HEAD) $orig_head &&
145 git symbolic-ref HEAD $head_name ||
146 die "Could not move back to $head_name"
152 move_to_original_branch
162 interactive_rebase=explicit
165 -p|--preserve-merges)
166 interactive_rebase=implied
172 if [ "$interactive_rebase" = implied ]; then
177 test -n "$interactive_rebase" || test -f "$dotest"/interactive
180 run_pre_rebase_hook () {
181 if test -z "$OK_TO_SKIP_PRE_REBASE" &&
182 test -x "$GIT_DIR/hooks/pre-rebase"
184 "$GIT_DIR/hooks/pre-rebase" ${1+"$@"} || {
185 echo >&2 "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)
338 --committer-date-is-author-date|--ignore-date)
339 git_am_opt="$git_am_opt $1"
343 git_am_opt="$git_am_opt $1"
348 -f|--f|--fo|--for|--forc|force|--force-r|--force-re|--force-reb|--force-reba|--force-rebas|--force-rebase)
360 test $# -gt 2 && usage
362 # Make sure we do not have $GIT_DIR/rebase-apply
363 if test -z "$do_merge"
365 if mkdir "$GIT_DIR"/rebase-apply 2>/dev/null
367 rmdir "$GIT_DIR"/rebase-apply
370 It seems that I cannot create a rebase-apply directory, and
371 I wonder if you are in the middle of patch application or another
372 rebase. If that is not the case, please
373 rm -fr '"$GIT_DIR"'/rebase-apply
374 and run me again. I am stopping in case you still have something
381 die "previous rebase directory $dotest still exists." \
382 'Try git rebase (--continue | --abort | --skip)'
386 # The tree must be really really clean.
387 if ! git update-index --ignore-submodules --refresh; then
388 echo >&2 "cannot rebase: you have unstaged changes"
391 diff=$(git diff-index --cached --name-status -r --ignore-submodules HEAD --)
393 ?*) echo >&2 "cannot rebase: your index contains uncommitted changes"
399 if test -z "$rebase_root"
401 # The upstream head must be given. Make sure it is valid.
404 upstream=`git rev-parse --verify "${upstream_name}^0"` ||
405 die "invalid upstream $upstream_name"
407 upstream_arg="$upstream_name"
409 test -z "$newbase" && die "--root must be used with --onto"
413 upstream_arg="$root_flag"
416 # Make sure the branch to rebase onto is valid.
417 onto_name=${newbase-"$upstream_name"}
418 onto=$(git rev-parse --verify "${onto_name}^0") || exit
420 # If a hook exists, give it a chance to interrupt
421 run_pre_rebase_hook "$upstream_arg" "$@"
423 # If the branch to rebase is given, that is the branch we will rebase
424 # $branch_name -- branch being rebased, or HEAD (already detached)
425 # $orig_head -- commit object name of tip of the branch before rebasing
426 # $head_name -- refs/heads/<that-branch> or "detached HEAD"
430 # Is it "rebase other $branchname" or "rebase other $commit"?
434 if git show-ref --verify --quiet -- "refs/heads/$1" &&
435 branch=$(git rev-parse -q --verify "refs/heads/$1")
437 head_name="refs/heads/$1"
438 elif branch=$(git rev-parse -q --verify "$1")
440 head_name="detached HEAD"
446 # Do not need to switch branches, we are already on it.
447 if branch_name=`git symbolic-ref -q HEAD`
449 head_name=$branch_name
450 branch_name=`expr "z$branch_name" : 'zrefs/heads/\(.*\)'`
452 head_name="detached HEAD"
453 branch_name=HEAD ;# detached
455 branch=$(git rev-parse --verify "${branch_name}^0") || exit
460 # Now we are rebasing commits $upstream..$branch (or with --root,
461 # everything leading up to $branch) on top of $onto
463 # Check if we are already based on $onto with linear history,
464 # but this should be done only when upstream and onto are the same.
465 mb=$(git merge-base "$onto" "$branch")
466 if test "$upstream" = "$onto" && test "$mb" = "$onto" &&
468 ! (git rev-list --parents "$onto".."$branch" | grep " .* ") > /dev/null
470 if test -z "$force_rebase"
472 # Lazily switch to the target branch if needed...
473 test -z "$switch_to" || git checkout "$switch_to"
474 say "Current branch $branch_name is up to date."
477 say "Current branch $branch_name is up to date, rebase forced."
481 # Detach HEAD and reset the tree
482 say "First, rewinding head to replay your work on top of it..."
483 git checkout -q "$onto^0" || die "could not detach HEAD"
484 git update-ref ORIG_HEAD $branch
486 if test -n "$diffstat"
488 if test -n "$verbose"
490 echo "Changes from $mb to $onto:"
492 # We want color (if set), but no pager
493 GIT_PAGER='' git diff --stat --summary "$mb" "$onto"
496 # If the $onto is a proper descendant of the tip of the branch, then
497 # we just fast forwarded.
498 if test "$mb" = "$branch"
500 say "Fast-forwarded $branch_name to $onto_name."
501 move_to_original_branch
505 if test -n "$rebase_root"
507 revisions="$onto..$orig_head"
509 revisions="$upstream..$orig_head"
512 if test -z "$do_merge"
514 git format-patch -k --stdout --full-index --ignore-if-in-upstream \
515 $root_flag "$revisions" |
516 git am $git_am_opt --rebasing --resolvemsg="$RESOLVEMSG" &&
517 move_to_original_branch
519 test 0 != $ret -a -d "$GIT_DIR"/rebase-apply &&
520 echo $head_name > "$GIT_DIR"/rebase-apply/head-name &&
521 echo $onto > "$GIT_DIR"/rebase-apply/onto &&
522 echo $orig_head > "$GIT_DIR"/rebase-apply/orig-head &&
523 echo "$GIT_QUIET" > "$GIT_DIR"/rebase-apply/quiet
527 # start doing a rebase with git-merge
528 # this is rename-aware if the recursive (default) strategy is used
531 echo "$onto" > "$dotest/onto"
532 echo "$onto_name" > "$dotest/onto_name"
534 echo "$prev_head" > "$dotest/prev_head"
535 echo "$orig_head" > "$dotest/orig-head"
536 echo "$head_name" > "$dotest/head-name"
537 echo "$GIT_QUIET" > "$dotest/quiet"
540 for cmt in `git rev-list --reverse --no-merges "$revisions"`
542 msgnum=$(($msgnum + 1))
543 echo "$cmt" > "$dotest/cmt.$msgnum"
546 echo 1 >"$dotest/msgnum"
547 echo $msgnum >"$dotest/end"
552 while test "$msgnum" -le "$end"