3 # Copyright (c) 2005 Junio C Hamano.
6 USAGE
='[--interactive | -i] [-v] [--force-rebase | -f] [--no-ff] [--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\".
49 merge_dir
="$GIT_DIR"/rebase-merge
50 apply_dir
="$GIT_DIR"/rebase-apply
54 test "$(git config --bool rebase.stat)" = true
&& diffstat
=t
58 allow_rerere_autoupdate
=
59 # Non-empty if a rebase was in progress when 'git rebase' was invoked
61 # One of {am, merge, interactive}
63 # One of {"$GIT_DIR"/rebase-apply, "$GIT_DIR"/rebase-merge}
65 # One of {'', continue, skip, abort}, as parsed from command line
69 if test "$type" = merge
71 onto_name
=$
(cat "$state_dir"/onto_name
) &&
72 end
=$
(cat "$state_dir"/end
) &&
73 msgnum
=$
(cat "$state_dir"/msgnum
)
75 head_name
=$
(cat "$state_dir"/head-name
) &&
76 onto
=$
(cat "$state_dir"/onto
) &&
77 orig_head
=$
(cat "$state_dir"/orig-head
) &&
78 GIT_QUIET
=$
(cat "$state_dir"/quiet
)
82 test -d "$merge_dir" || die
"$merge_dir directory does not exist"
84 unmerged
=$
(git ls-files
-u)
85 if test -n "$unmerged"
87 echo "You still have unmerged paths in your index"
88 echo "did you forget to use git add?"
92 cmt
=`cat "$merge_dir/current"`
93 if ! git diff-index
--quiet --ignore-submodules HEAD
--
95 if ! git commit
--no-verify -C "$cmt"
97 echo "Commit failed, please do not call \"git commit\""
98 echo "directly, but instead do one of the following: "
101 if test -z "$GIT_QUIET"
103 printf "Committed: %0${prec}d " $msgnum
105 echo "$cmt $(git rev-parse HEAD^0)" >> "$merge_dir/rewritten"
107 if test -z "$GIT_QUIET"
109 printf "Already applied: %0${prec}d " $msgnum
112 test -z "$GIT_QUIET" &&
113 GIT_PAGER
='' git log
--format=%s
-1 "$cmt"
115 # onto the next patch:
116 msgnum
=$
(($msgnum + 1))
117 echo "$msgnum" >"$merge_dir/msgnum"
121 cmt
="$(cat "$merge_dir/cmt.
$1")"
122 echo "$cmt" > "$merge_dir/current"
123 hd
=$
(git rev-parse
--verify HEAD
)
124 cmt_name
=$
(git symbolic-ref HEAD
2> /dev
/null ||
echo HEAD
)
125 msgnum
=$
(cat "$merge_dir/msgnum")
126 eval GITHEAD_
$cmt='"${cmt_name##refs/heads/}~$(($end - $msgnum))"'
127 eval GITHEAD_
$hd='$onto_name'
128 export GITHEAD_
$cmt GITHEAD_
$hd
129 if test -n "$GIT_QUIET"
131 GIT_MERGE_VERBOSITY
=1 && export GIT_MERGE_VERBOSITY
133 eval 'git-merge-$strategy' $strategy_opts '"$cmt^" -- "$hd" "$cmt"'
137 unset GITHEAD_
$cmt GITHEAD_
$hd
141 git rerere
$allow_rerere_autoupdate
145 echo "Strategy: $rv $strategy failed, try another" 1>&2
149 die
"Unknown exit code ($rv) from command:" \
150 "git-merge-$strategy $cmt^ -- HEAD $cmt"
155 move_to_original_branch
() {
158 message
="rebase finished: $head_name onto $onto"
159 git update-ref
-m "$message" \
160 $head_name $
(git rev-parse HEAD
) $orig_head &&
161 git symbolic-ref HEAD
$head_name ||
162 die
"Could not move back to $head_name"
168 move_to_original_branch
169 git notes copy
--for-rewrite=rebase
< "$merge_dir"/rewritten
170 if test -x "$GIT_DIR"/hooks
/post-rewrite
&&
171 test -s "$merge_dir"/rewritten
; then
172 "$GIT_DIR"/hooks
/post-rewrite rebase
< "$merge_dir"/rewritten
183 interactive_rebase
=explicit
186 -p|
--preserve-merges)
187 interactive_rebase
=implied
193 if [ "$interactive_rebase" = implied
]; then
198 test -n "$interactive_rebase" ||
test -f "$merge_dir"/interactive
201 run_pre_rebase_hook
() {
202 if test -z "$OK_TO_SKIP_PRE_REBASE" &&
203 test -x "$GIT_DIR/hooks/pre-rebase"
205 "$GIT_DIR/hooks/pre-rebase" ${1+"$@"} ||
206 die
"The pre-rebase hook refused to rebase."
210 test -f "$apply_dir"/applying
&&
211 die
'It looks like git-am is in progress. Cannot rebase.'
213 is_interactive
"$@" && exec git-rebase--interactive
"$@"
215 if test -d "$apply_dir"
218 state_dir
="$apply_dir"
219 elif test -d "$merge_dir"
221 if test -f "$merge_dir"/interactive
224 interactive_rebase
=explicit
228 state_dir
="$merge_dir"
230 test -n "$type" && in_progress
=t
236 OK_TO_SKIP_PRE_REBASE
=yes
239 OK_TO_SKIP_PRE_REBASE
=
241 --continue|
--skip|
--abort)
247 test 2 -le "$#" || usage
251 -M|
-m|
--m|
--me|
--mer|
--merg|
--merge)
254 -X*|
--strategy-option*)
256 1,-X|
1,--strategy-option)
258 *,-X|
*,--strategy-option)
261 *,--strategy-option=*)
262 newopt
="$(expr " $1" : ' --strategy-option=\(.*\)')" ;;
264 newopt
="$(expr " $1" : ' -X\(.*\)')" ;;
268 strategy_opts
="$strategy_opts $(git rev-parse --sq-quote "--$newopt")"
271 -s=*|
--s=*|
--st=*|
--str=*|
--stra=*|
--strat=*|
--strate=*|\
272 --strateg=*|
--strategy=*|\
273 -s|
--s|
--st|
--str|
--stra|
--strat|
--strate|
--strateg|
--strategy)
276 strategy
=`expr "z$1" : 'z-[^=]*=\(.*\)'` ;;
298 git_am_opt
="$git_am_opt -q"
303 git_am_opt
="$git_am_opt $1"
305 --whitespace=fix|
--whitespace=strip
)
311 git_am_opt
="$git_am_opt $1"
313 --committer-date-is-author-date|
--ignore-date)
314 git_am_opt
="$git_am_opt $1"
318 git_am_opt
="$git_am_opt $1"
323 -f|
--f|
--fo|
--for|
--forc|
--force|
--force-r|
--force-re|
--force-reb|
--force-reba|
--force-rebas|
--force-rebase|
--no-ff)
326 --rerere-autoupdate|
--no-rerere-autoupdate)
327 allow_rerere_autoupdate
="$1"
338 test $# -gt 2 && usage
340 test -n "$action" && test -z "$in_progress" && die
"No rebase in progress?"
344 git update-index
--ignore-submodules --refresh &&
345 git diff-files
--quiet --ignore-submodules ||
{
346 echo "You must edit all merge conflicts and then"
347 echo "mark them as resolved using git add"
351 if test -d "$merge_dir"
354 while test "$msgnum" -le "$end"
362 git am
--resolved --3way --resolvemsg="$RESOLVEMSG" &&
363 move_to_original_branch
367 git
reset --hard HEAD ||
exit $?
369 if test -d "$merge_dir"
372 msgnum
=$
(($msgnum + 1))
373 while test "$msgnum" -le "$end"
381 git am
-3 --skip --resolvemsg="$RESOLVEMSG" &&
382 move_to_original_branch
390 git symbolic-ref HEAD
$head_name ||
391 die
"Could not move back to $head_name"
394 git
reset --hard $orig_head
400 # Make sure no rebase is in progress
401 if test -n "$in_progress"
404 It seems that there is already a '"${state_dir##*/}"' directory, and
405 I wonder if you are in the middle of another rebase. If that is the
407 git rebase (--continue | --abort | --skip)
408 If that is not the case, please
409 rm -fr '"$state_dir"'
410 and run me again. I am stopping in case you still have something
414 test $# -eq 0 && test -z "$rebase_root" && usage
416 require_clean_work_tree
"rebase" "Please commit or stash them."
418 if test -z "$rebase_root"
420 # The upstream head must be given. Make sure it is valid.
423 upstream
=`git rev-parse --verify "${upstream_name}^0"` ||
424 die
"invalid upstream $upstream_name"
426 upstream_arg
="$upstream_name"
428 test -z "$newbase" && die
"--root must be used with --onto"
432 upstream_arg
="$root_flag"
435 # Make sure the branch to rebase onto is valid.
436 onto_name
=${newbase-"$upstream_name"}
439 if left
=${onto_name%...*} right
=${onto_name#*...} &&
440 onto
=$
(git merge-base
--all ${left:-HEAD} ${right:-HEAD})
444 die
"$onto_name: there are more than one merge bases"
447 die
"$onto_name: there is no merge base"
451 die
"$onto_name: there is no merge base"
455 onto
=$
(git rev-parse
--verify "${onto_name}^0") ||
exit
459 # If a hook exists, give it a chance to interrupt
460 run_pre_rebase_hook
"$upstream_arg" "$@"
462 # If the branch to rebase is given, that is the branch we will rebase
463 # $branch_name -- branch being rebased, or HEAD (already detached)
464 # $orig_head -- commit object name of tip of the branch before rebasing
465 # $head_name -- refs/heads/<that-branch> or "detached HEAD"
469 # Is it "rebase other $branchname" or "rebase other $commit"?
473 if git show-ref
--verify --quiet -- "refs/heads/$1" &&
474 branch
=$
(git rev-parse
-q --verify "refs/heads/$1")
476 head_name
="refs/heads/$1"
477 elif branch
=$
(git rev-parse
-q --verify "$1")
479 head_name
="detached HEAD"
481 echo >&2 "fatal: no such branch: $1"
486 # Do not need to switch branches, we are already on it.
487 if branch_name
=`git symbolic-ref -q HEAD`
489 head_name
=$branch_name
490 branch_name
=`expr "z$branch_name" : 'zrefs/heads/\(.*\)'`
492 head_name
="detached HEAD"
493 branch_name
=HEAD
;# detached
495 branch
=$
(git rev-parse
--verify "${branch_name}^0") ||
exit
500 # Now we are rebasing commits $upstream..$branch (or with --root,
501 # everything leading up to $branch) on top of $onto
503 # Check if we are already based on $onto with linear history,
504 # but this should be done only when upstream and onto are the same.
505 mb
=$
(git merge-base
"$onto" "$branch")
506 if test "$upstream" = "$onto" && test "$mb" = "$onto" &&
508 ! (git rev-list
--parents "$onto"..
"$branch" | sane_grep
" .* ") > /dev
/null
510 if test -z "$force_rebase"
512 # Lazily switch to the target branch if needed...
513 test -z "$switch_to" || git checkout
"$switch_to" --
514 say
"Current branch $branch_name is up to date."
517 say
"Current branch $branch_name is up to date, rebase forced."
521 # Detach HEAD and reset the tree
522 say
"First, rewinding head to replay your work on top of it..."
523 git checkout
-q "$onto^0" || die
"could not detach HEAD"
524 git update-ref ORIG_HEAD
$branch
526 if test -n "$diffstat"
528 if test -n "$verbose"
530 echo "Changes from $mb to $onto:"
532 # We want color (if set), but no pager
533 GIT_PAGER
='' git
diff --stat --summary "$mb" "$onto"
536 # If the $onto is a proper descendant of the tip of the branch, then
537 # we just fast-forwarded.
538 if test "$mb" = "$branch"
540 say
"Fast-forwarded $branch_name to $onto_name."
541 move_to_original_branch
545 if test -n "$rebase_root"
547 revisions
="$onto..$orig_head"
549 revisions
="$upstream..$orig_head"
552 if test -z "$do_merge"
554 git format-patch
-k --stdout --full-index --ignore-if-in-upstream \
555 --src-prefix=a
/ --dst-prefix=b
/ \
556 --no-renames $root_flag "$revisions" |
557 git am
$git_am_opt --rebasing --resolvemsg="$RESOLVEMSG" &&
558 move_to_original_branch
560 test 0 != $ret -a -d "$apply_dir" &&
561 echo $head_name > "$apply_dir/head-name" &&
562 echo $onto > "$apply_dir/onto" &&
563 echo $orig_head > "$apply_dir/orig-head" &&
564 echo "$GIT_QUIET" > "$apply_dir/quiet"
568 # start doing a rebase with git-merge
569 # this is rename-aware if the recursive (default) strategy is used
571 mkdir
-p "$merge_dir"
572 echo "$onto_name" > "$merge_dir/onto_name"
573 echo "$head_name" > "$merge_dir/head-name"
574 echo "$onto" > "$merge_dir/onto"
575 echo "$orig_head" > "$merge_dir/orig-head"
576 echo "$GIT_QUIET" > "$merge_dir/quiet"
579 for cmt
in `git rev-list --reverse --no-merges "$revisions"`
581 msgnum
=$
(($msgnum + 1))
582 echo "$cmt" > "$merge_dir/cmt.$msgnum"
585 echo 1 >"$merge_dir/msgnum"
586 echo $msgnum >"$merge_dir/end"
591 while test "$msgnum" -le "$end"