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
53 test "$(git config --bool rebase.stat)" = true
&& diffstat
=t
57 allow_rerere_autoupdate
=
58 # Non-empty if a rebase was in progress when 'git rebase' was invoked
60 # One of {am, merge, interactive}
62 # One of {"$GIT_DIR"/rebase-apply, "$GIT_DIR"/rebase-merge}
64 # One of {'', continue, skip, abort}, as parsed from command line
68 test "$(git config --bool rebase.autosquash)" = "true" && autosquash
=t
71 head_name
=$
(cat "$state_dir"/head-name
) &&
72 onto
=$
(cat "$state_dir"/onto
) &&
73 # We always write to orig-head, but interactive rebase used to write to
74 # head. Fall back to reading from head to cover for the case that the
75 # user upgraded git with an ongoing interactive rebase.
76 if test -f "$state_dir"/orig-head
78 orig_head
=$
(cat "$state_dir"/orig-head
)
80 orig_head
=$
(cat "$state_dir"/head)
82 GIT_QUIET
=$
(cat "$state_dir"/quiet
) &&
83 test -f "$state_dir"/verbose
&& verbose
=t
86 write_basic_state
() {
87 echo "$head_name" > "$state_dir"/head-name
&&
88 echo "$onto" > "$state_dir"/onto
&&
89 echo "$orig_head" > "$state_dir"/orig-head
&&
90 echo "$GIT_QUIET" > "$state_dir"/quiet
&&
91 test t
= "$verbose" && : > "$state_dir"/verbose
99 test $status != 0 && printf "%s\n" "$output"
108 move_to_original_branch
() {
111 message
="rebase finished: $head_name onto $onto"
112 git update-ref
-m "$message" \
113 $head_name $
(git rev-parse HEAD
) $orig_head &&
114 git symbolic-ref HEAD
$head_name ||
115 die
"Could not move back to $head_name"
120 run_specific_rebase
() {
121 if [ "$interactive_rebase" = implied
]; then
128 run_pre_rebase_hook
() {
129 if test -z "$ok_to_skip_pre_rebase" &&
130 test -x "$GIT_DIR/hooks/pre-rebase"
132 "$GIT_DIR/hooks/pre-rebase" ${1+"$@"} ||
133 die
"The pre-rebase hook refused to rebase."
137 test -f "$apply_dir"/applying
&&
138 die
'It looks like git-am is in progress. Cannot rebase.'
140 if test -d "$apply_dir"
143 state_dir
="$apply_dir"
144 elif test -d "$merge_dir"
146 if test -f "$merge_dir"/interactive
149 interactive_rebase
=explicit
153 state_dir
="$merge_dir"
155 test -n "$type" && in_progress
=t
162 ok_to_skip_pre_rebase
=yes
165 ok_to_skip_pre_rebase
=
167 --continue|
--skip|
--abort)
168 test $total_argc -eq 1 || usage
172 test 2 -le "$#" || usage
177 interactive_rebase
=explicit
179 -p|
--preserve-merges)
181 test -z "$interactive_rebase" && interactive_rebase
=implied
189 -M|
-m|
--m|
--me|
--mer|
--merg|
--merge)
192 -X*|
--strategy-option*)
194 1,-X|
1,--strategy-option)
196 *,-X|
*,--strategy-option)
199 *,--strategy-option=*)
200 newopt
="$(expr " $1" : ' --strategy-option=\(.*\)')" ;;
202 newopt
="$(expr " $1" : ' -X\(.*\)')" ;;
206 strategy_opts
="$strategy_opts $(git rev-parse --sq-quote "--$newopt")"
208 test -z "$strategy" && strategy
=recursive
210 -s=*|
--s=*|
--st=*|
--str=*|
--stra=*|
--strat=*|
--strate=*|\
211 --strateg=*|
--strategy=*|\
212 -s|
--s|
--st|
--str|
--stra|
--strat|
--strate|
--strateg|
--strategy)
215 strategy
=`expr "z$1" : 'z-[^=]*=\(.*\)'` ;;
237 git_am_opt
="$git_am_opt -q"
242 git_am_opt
="$git_am_opt $1"
244 --whitespace=fix|
--whitespace=strip
)
250 git_am_opt
="$git_am_opt $1"
252 --committer-date-is-author-date|
--ignore-date)
253 git_am_opt
="$git_am_opt $1"
257 git_am_opt
="$git_am_opt $1"
262 -f|
--f|
--fo|
--for|
--forc|
--force|
--force-r|
--force-re|
--force-reb|
--force-reba|
--force-rebas|
--force-rebase|
--no-ff)
265 --rerere-autoupdate|
--no-rerere-autoupdate)
266 allow_rerere_autoupdate
="$1"
277 test $# -gt 2 && usage
281 test -z "$in_progress" && die
"No rebase in progress?"
282 # Only interactive rebase uses detailed reflog messages
283 if test "$type" = interactive
&& test "$GIT_REFLOG_ACTION" = rebase
285 GIT_REFLOG_ACTION
="rebase -i ($action)"
286 export GIT_REFLOG_ACTION
293 git rev-parse
--verify HEAD
>/dev
/null ||
294 die
"Cannot read HEAD"
295 git update-index
--ignore-submodules --refresh &&
296 git diff-files
--quiet --ignore-submodules ||
{
297 echo "You must edit all merge conflicts and then"
298 echo "mark them as resolved using git add"
305 output git
reset --hard HEAD ||
exit $?
314 git symbolic-ref HEAD
$head_name ||
315 die
"Could not move back to $head_name"
318 output git
reset --hard $orig_head
324 # Make sure no rebase is in progress
325 if test -n "$in_progress"
328 It seems that there is already a '"${state_dir##*/}"' directory, and
329 I wonder if you are in the middle of another rebase. If that is the
331 git rebase (--continue | --abort | --skip)
332 If that is not the case, please
333 rm -fr '"$state_dir"'
334 and run me again. I am stopping in case you still have something
338 test $# -eq 0 && test -z "$rebase_root" && usage
340 if test -n "$interactive_rebase"
343 state_dir
="$merge_dir"
344 elif test -n "$do_merge"
347 state_dir
="$merge_dir"
350 state_dir
="$apply_dir"
353 if test -z "$rebase_root"
355 # The upstream head must be given. Make sure it is valid.
358 upstream
=`git rev-parse --verify "${upstream_name}^0"` ||
359 die
"invalid upstream $upstream_name"
360 upstream_arg
="$upstream_name"
362 test -z "$onto" && die
"You must specify --onto when using --root"
368 # Make sure the branch to rebase onto is valid.
369 onto_name
=${onto-"$upstream_name"}
372 if left
=${onto_name%...*} right
=${onto_name#*...} &&
373 onto
=$
(git merge-base
--all ${left:-HEAD} ${right:-HEAD})
377 die
"$onto_name: there are more than one merge bases"
380 die
"$onto_name: there is no merge base"
384 die
"$onto_name: there is no merge base"
388 onto
=$
(git rev-parse
--verify "${onto_name}^0") ||
389 die
"Does not point to a valid commit: $1"
393 # If the branch to rebase is given, that is the branch we will rebase
394 # $branch_name -- branch being rebased, or HEAD (already detached)
395 # $orig_head -- commit object name of tip of the branch before rebasing
396 # $head_name -- refs/heads/<that-branch> or "detached HEAD"
400 # Is it "rebase other $branchname" or "rebase other $commit"?
404 if git show-ref
--verify --quiet -- "refs/heads/$1" &&
405 orig_head
=$
(git rev-parse
-q --verify "refs/heads/$1")
407 head_name
="refs/heads/$1"
408 elif orig_head
=$
(git rev-parse
-q --verify "$1")
410 head_name
="detached HEAD"
412 echo >&2 "fatal: no such branch: $1"
417 # Do not need to switch branches, we are already on it.
418 if branch_name
=`git symbolic-ref -q HEAD`
420 head_name
=$branch_name
421 branch_name
=`expr "z$branch_name" : 'zrefs/heads/\(.*\)'`
423 head_name
="detached HEAD"
424 branch_name
=HEAD
;# detached
426 orig_head
=$
(git rev-parse
--verify "${branch_name}^0") ||
exit
430 require_clean_work_tree
"rebase" "Please commit or stash them."
432 # Now we are rebasing commits $upstream..$orig_head (or with --root,
433 # everything leading up to $orig_head) on top of $onto
435 # Check if we are already based on $onto with linear history,
436 # but this should be done only when upstream and onto are the same
437 # and if this is not an interactive rebase.
438 mb
=$
(git merge-base
"$onto" "$orig_head")
439 if test "$type" != interactive
&& test "$upstream" = "$onto" &&
440 test "$mb" = "$onto" &&
442 ! (git rev-list
--parents "$onto"..
"$orig_head" | sane_grep
" .* ") > /dev
/null
444 if test -z "$force_rebase"
446 # Lazily switch to the target branch if needed...
447 test -z "$switch_to" || git checkout
"$switch_to" --
448 say
"Current branch $branch_name is up to date."
451 say
"Current branch $branch_name is up to date, rebase forced."
455 # If a hook exists, give it a chance to interrupt
456 run_pre_rebase_hook
"$upstream_arg" "$@"
458 if test -n "$diffstat"
460 if test -n "$verbose"
462 echo "Changes from $mb to $onto:"
464 # We want color (if set), but no pager
465 GIT_PAGER
='' git
diff --stat --summary "$mb" "$onto"
468 test "$type" = interactive
&& run_specific_rebase
470 # Detach HEAD and reset the tree
471 say
"First, rewinding head to replay your work on top of it..."
472 git checkout
-q "$onto^0" || die
"could not detach HEAD"
473 git update-ref ORIG_HEAD
$orig_head
475 # If the $onto is a proper descendant of the tip of the branch, then
476 # we just fast-forwarded.
477 if test "$mb" = "$orig_head"
479 say
"Fast-forwarded $branch_name to $onto_name."
480 move_to_original_branch
484 if test -n "$rebase_root"
486 revisions
="$onto..$orig_head"
488 revisions
="$upstream..$orig_head"