]> git.ipfire.org Git - thirdparty/git.git/blame - git-rebase--interactive.sh
config.c: guard config parser from value=NULL
[thirdparty/git.git] / git-rebase--interactive.sh
CommitLineData
1b1dce4b
JS
1#!/bin/sh
2#
3# Copyright (c) 2006 Johannes E. Schindelin
4
5# SHORT DESCRIPTION
6#
7# This script makes it easy to fix up commits in the middle of a series,
8# and rearrange commits.
9#
10# The original idea comes from Eric W. Biederman, in
11# http://article.gmane.org/gmane.comp.version-control.git/22407
12
f09c9b8c
JS
13USAGE='(--continue | --abort | --skip | [--preserve-merges] [--verbose]
14 [--onto <branch>] <upstream> [<branch>])'
1b1dce4b 15
8f321a39 16OPTIONS_SPEC=
1b1dce4b
JS
17. git-sh-setup
18require_work_tree
19
20DOTEST="$GIT_DIR/.dotest-merge"
c22486c9 21TODO="$DOTEST"/git-rebase-todo
1b1dce4b 22DONE="$DOTEST"/done
6368f3f8
JS
23MSG="$DOTEST"/message
24SQUASH_MSG="$DOTEST"/message-squash
f09c9b8c
JS
25REWRITTEN="$DOTEST"/rewritten
26PRESERVE_MERGES=
1b1dce4b
JS
27STRATEGY=
28VERBOSE=
8e4a91bd
JS
29test -d "$REWRITTEN" && PRESERVE_MERGES=t
30test -f "$DOTEST"/strategy && STRATEGY="$(cat "$DOTEST"/strategy)"
31test -f "$DOTEST"/verbose && VERBOSE=t
1b1dce4b 32
804c7174
WC
33GIT_CHERRY_PICK_HELP=" After resolving the conflicts,
34mark the corrected paths with 'git add <paths>', and
35run 'git rebase --continue'"
36export GIT_CHERRY_PICK_HELP
37
1b1dce4b
JS
38warn () {
39 echo "$*" >&2
40}
41
dfa49f33
JS
42output () {
43 case "$VERBOSE" in
44 '')
5166810b 45 output=$("$@" 2>&1 )
dfa49f33 46 status=$?
5166810b 47 test $status != 0 && printf "%s\n" "$output"
dfa49f33 48 return $status
376ccb8c 49 ;;
dfa49f33
JS
50 *)
51 "$@"
376ccb8c 52 ;;
dfa49f33
JS
53 esac
54}
55
1b1dce4b
JS
56require_clean_work_tree () {
57 # test if working tree is dirty
58 git rev-parse --verify HEAD > /dev/null &&
59 git update-index --refresh &&
60 git diff-files --quiet &&
38762c47 61 git diff-index --cached --quiet HEAD -- ||
1b1dce4b
JS
62 die "Working tree is dirty"
63}
64
65ORIG_REFLOG_ACTION="$GIT_REFLOG_ACTION"
66
67comment_for_reflog () {
68 case "$ORIG_REFLOG_ACTION" in
69 ''|rebase*)
70 GIT_REFLOG_ACTION="rebase -i ($1)"
71 export GIT_REFLOG_ACTION
376ccb8c 72 ;;
1b1dce4b
JS
73 esac
74}
75
4e673877 76last_count=
1b1dce4b
JS
77mark_action_done () {
78 sed -e 1q < "$TODO" >> "$DONE"
79 sed -e 1d < "$TODO" >> "$TODO".new
80 mv -f "$TODO".new "$TODO"
dad4e32c
JS
81 count=$(($(grep -ve '^$' -e '^#' < "$DONE" | wc -l)))
82 total=$(($count+$(grep -ve '^$' -e '^#' < "$TODO" | wc -l)))
4e673877
JH
83 if test "$last_count" != "$count"
84 then
85 last_count=$count
86 printf "Rebasing (%d/%d)\r" $count $total
87 test -z "$VERBOSE" || echo
88 fi
1b1dce4b
JS
89}
90
91make_patch () {
be6ff208
JS
92 parent_sha1=$(git rev-parse --verify "$1"^) ||
93 die "Cannot get patch for $1^"
f3d5e463 94 git diff-tree -p "$parent_sha1".."$1" > "$DOTEST"/patch
be6ff208
JS
95 test -f "$DOTEST"/message ||
96 git cat-file commit "$1" | sed "1,/^$/d" > "$DOTEST"/message
97 test -f "$DOTEST"/author-script ||
98 get_author_ident_from_commit "$1" > "$DOTEST"/author-script
1b1dce4b
JS
99}
100
101die_with_patch () {
102 make_patch "$1"
ecfe72ff 103 git rerere
1b1dce4b
JS
104 die "$2"
105}
106
c54b7817
JS
107die_abort () {
108 rm -rf "$DOTEST"
109 die "$1"
110}
111
376ccb8c
JS
112has_action () {
113 grep -vqe '^$' -e '^#' "$1"
114}
115
1b1dce4b 116pick_one () {
1d25c8cf
JS
117 no_ff=
118 case "$1" in -n) sha1=$2; no_ff=t ;; *) sha1=$1 ;; esac
dfa49f33 119 output git rev-parse --verify $sha1 || die "Invalid commit name: $sha1"
f09c9b8c
JS
120 test -d "$REWRITTEN" &&
121 pick_one_preserving_merges "$@" && return
376ccb8c
JS
122 parent_sha1=$(git rev-parse --verify $sha1^) ||
123 die "Could not get the parent of $sha1"
1b1dce4b 124 current_sha1=$(git rev-parse --verify HEAD)
2858028e 125 if test "$no_ff$current_sha1" = "$parent_sha1"; then
dfa49f33
JS
126 output git reset --hard $sha1
127 test "a$1" = a-n && output git reset --soft $current_sha1
1b1dce4b 128 sha1=$(git rev-parse --short $sha1)
dfa49f33 129 output warn Fast forward to $sha1
1b1dce4b 130 else
2a9c53e0 131 output git cherry-pick "$@"
1b1dce4b
JS
132 fi
133}
134
f09c9b8c
JS
135pick_one_preserving_merges () {
136 case "$1" in -n) sha1=$2 ;; *) sha1=$1 ;; esac
137 sha1=$(git rev-parse $sha1)
138
3b38ec16 139 if test -f "$DOTEST"/current-commit
f09c9b8c
JS
140 then
141 current_commit=$(cat "$DOTEST"/current-commit) &&
142 git rev-parse HEAD > "$REWRITTEN"/$current_commit &&
143 rm "$DOTEST"/current-commit ||
144 die "Cannot write current commit's replacement sha1"
145 fi
146
147 # rewrite parents; if none were rewritten, we can fast-forward.
148 fast_forward=t
149 preserve=t
150 new_parents=
376ccb8c 151 for p in $(git rev-list --parents -1 $sha1 | cut -d' ' -f2-)
f09c9b8c 152 do
3b38ec16 153 if test -f "$REWRITTEN"/$p
f09c9b8c
JS
154 then
155 preserve=f
156 new_p=$(cat "$REWRITTEN"/$p)
157 test $p != $new_p && fast_forward=f
158 case "$new_parents" in
159 *$new_p*)
160 ;; # do nothing; that parent is already there
161 *)
162 new_parents="$new_parents $new_p"
376ccb8c 163 ;;
f09c9b8c
JS
164 esac
165 fi
166 done
167 case $fast_forward in
168 t)
dfa49f33 169 output warn "Fast forward to $sha1"
376ccb8c 170 test $preserve = f || echo $sha1 > "$REWRITTEN"/$sha1
f09c9b8c
JS
171 ;;
172 f)
173 test "a$1" = a-n && die "Refusing to squash a merge: $sha1"
174
376ccb8c 175 first_parent=$(expr "$new_parents" : ' \([^ ]*\)')
f09c9b8c 176 # detach HEAD to current parent
dfa49f33 177 output git checkout $first_parent 2> /dev/null ||
f09c9b8c
JS
178 die "Cannot move HEAD to $first_parent"
179
180 echo $sha1 > "$DOTEST"/current-commit
181 case "$new_parents" in
376ccb8c 182 ' '*' '*)
f09c9b8c
JS
183 # redo merge
184 author_script=$(get_author_ident_from_commit $sha1)
185 eval "$author_script"
376ccb8c 186 msg="$(git cat-file commit $sha1 | sed -e '1,/^$/d')"
f91333d6
BS
187 # No point in merging the first parent, that's HEAD
188 new_parents=${new_parents# $first_parent}
ae830ed7
JS
189 if ! GIT_AUTHOR_NAME="$GIT_AUTHOR_NAME" \
190 GIT_AUTHOR_EMAIL="$GIT_AUTHOR_EMAIL" \
191 GIT_AUTHOR_DATE="$GIT_AUTHOR_DATE" \
192 output git merge $STRATEGY -m "$msg" \
193 $new_parents
f09c9b8c 194 then
ecfe72ff 195 git rerere
376ccb8c 196 printf "%s\n" "$msg" > "$GIT_DIR"/MERGE_MSG
18640d99 197 die Error redoing merge $sha1
f09c9b8c
JS
198 fi
199 ;;
200 *)
2a9c53e0 201 output git cherry-pick "$@" ||
f09c9b8c 202 die_with_patch $sha1 "Could not pick $sha1"
376ccb8c 203 ;;
f09c9b8c 204 esac
376ccb8c 205 ;;
f09c9b8c
JS
206 esac
207}
208
6368f3f8
JS
209nth_string () {
210 case "$1" in
211 *1[0-9]|*[04-9]) echo "$1"th;;
212 *1) echo "$1"st;;
213 *2) echo "$1"nd;;
214 *3) echo "$1"rd;;
215 esac
216}
217
218make_squash_message () {
3b38ec16 219 if test -f "$SQUASH_MSG"; then
c7965afd 220 COUNT=$(($(sed -n "s/^# This is [^0-9]*\([1-9][0-9]*\).*/\1/p" \
6368f3f8
JS
221 < "$SQUASH_MSG" | tail -n 1)+1))
222 echo "# This is a combination of $COUNT commits."
8ad1065e
JH
223 sed -e 1d -e '2,/^./{
224 /^$/d
225 }' <"$SQUASH_MSG"
6368f3f8
JS
226 else
227 COUNT=2
228 echo "# This is a combination of two commits."
229 echo "# The first commit's message is:"
230 echo
231 git cat-file commit HEAD | sed -e '1,/^$/d'
6368f3f8 232 fi
8ad1065e 233 echo
6368f3f8
JS
234 echo "# This is the $(nth_string $COUNT) commit message:"
235 echo
236 git cat-file commit $1 | sed -e '1,/^$/d'
237}
238
239peek_next_command () {
240 sed -n "1s/ .*$//p" < "$TODO"
241}
242
1b1dce4b 243do_next () {
376ccb8c
JS
244 rm -f "$DOTEST"/message "$DOTEST"/author-script \
245 "$DOTEST"/amend || exit
1b1dce4b
JS
246 read command sha1 rest < "$TODO"
247 case "$command" in
376ccb8c 248 '#'*|'')
1b1dce4b 249 mark_action_done
1b1dce4b 250 ;;
f8babc4d 251 pick|p)
1b1dce4b
JS
252 comment_for_reflog pick
253
254 mark_action_done
255 pick_one $sha1 ||
256 die_with_patch $sha1 "Could not apply $sha1... $rest"
257 ;;
f8babc4d 258 edit|e)
1b1dce4b
JS
259 comment_for_reflog edit
260
261 mark_action_done
262 pick_one $sha1 ||
263 die_with_patch $sha1 "Could not apply $sha1... $rest"
264 make_patch $sha1
be6ff208 265 : > "$DOTEST"/amend
1b1dce4b
JS
266 warn
267 warn "You can amend the commit now, with"
268 warn
269 warn " git commit --amend"
270 warn
271 exit 0
272 ;;
f8babc4d 273 squash|s)
1b1dce4b
JS
274 comment_for_reflog squash
275
376ccb8c 276 has_action "$DONE" ||
1b1dce4b
JS
277 die "Cannot 'squash' without a previous commit"
278
279 mark_action_done
6368f3f8
JS
280 make_squash_message $sha1 > "$MSG"
281 case "$(peek_next_command)" in
f8babc4d 282 squash|s)
6368f3f8 283 EDIT_COMMIT=
91e1ee77 284 USE_OUTPUT=output
6368f3f8 285 cp "$MSG" "$SQUASH_MSG"
376ccb8c 286 ;;
6368f3f8
JS
287 *)
288 EDIT_COMMIT=-e
91e1ee77 289 USE_OUTPUT=
376ccb8c
JS
290 rm -f "$SQUASH_MSG" || exit
291 ;;
6368f3f8
JS
292 esac
293
793ad041 294 failed=f
81ab1cb4 295 author_script=$(get_author_ident_from_commit HEAD)
dfa49f33 296 output git reset --soft HEAD^
fb47cfbd 297 pick_one -n $sha1 || failed=t
18640d99 298 echo "$author_script" > "$DOTEST"/author-script
dbedf972
SP
299 if test $failed = f
300 then
1b1dce4b
JS
301 # This is like --amend, but with a different message
302 eval "$author_script"
ae830ed7
JS
303 GIT_AUTHOR_NAME="$GIT_AUTHOR_NAME" \
304 GIT_AUTHOR_EMAIL="$GIT_AUTHOR_EMAIL" \
305 GIT_AUTHOR_DATE="$GIT_AUTHOR_DATE" \
dbedf972
SP
306 $USE_OUTPUT git commit --no-verify -F "$MSG" $EDIT_COMMIT || failed=t
307 fi
308 if test $failed = t
309 then
1b1dce4b
JS
310 cp "$MSG" "$GIT_DIR"/MERGE_MSG
311 warn
312 warn "Could not apply $sha1... $rest"
1b1dce4b 313 die_with_patch $sha1 ""
dbedf972 314 fi
1b1dce4b
JS
315 ;;
316 *)
317 warn "Unknown command: $command $sha1 $rest"
318 die_with_patch $sha1 "Please fix this in the file $TODO."
376ccb8c 319 ;;
1b1dce4b
JS
320 esac
321 test -s "$TODO" && return
322
68a163c9
JS
323 comment_for_reflog finish &&
324 HEADNAME=$(cat "$DOTEST"/head-name) &&
325 OLDHEAD=$(cat "$DOTEST"/head) &&
326 SHORTONTO=$(git rev-parse --short $(cat "$DOTEST"/onto)) &&
3b38ec16 327 if test -d "$REWRITTEN"
f09c9b8c
JS
328 then
329 test -f "$DOTEST"/current-commit &&
330 current_commit=$(cat "$DOTEST"/current-commit) &&
331 git rev-parse HEAD > "$REWRITTEN"/$current_commit
34454e85
JS
332 if test -f "$REWRITTEN"/$OLDHEAD
333 then
334 NEWHEAD=$(cat "$REWRITTEN"/$OLDHEAD)
335 else
336 NEWHEAD=$OLDHEAD
337 fi
f09c9b8c
JS
338 else
339 NEWHEAD=$(git rev-parse HEAD)
340 fi &&
73697a0b
JS
341 case $HEADNAME in
342 refs/*)
343 message="$GIT_REFLOG_ACTION: $HEADNAME onto $SHORTONTO)" &&
344 git update-ref -m "$message" $HEADNAME $NEWHEAD $OLDHEAD &&
345 git symbolic-ref HEAD $HEADNAME
346 ;;
347 esac && {
3df0a859 348 test ! -f "$DOTEST"/verbose ||
f3d5e463 349 git diff-tree --stat $(cat "$DOTEST"/head)..HEAD
3df0a859 350 } &&
1b1dce4b 351 rm -rf "$DOTEST" &&
73697a0b 352 git gc --auto &&
1b1dce4b
JS
353 warn "Successfully rebased and updated $HEADNAME."
354
355 exit
356}
357
358do_rest () {
359 while :
360 do
361 do_next
362 done
1b1dce4b
JS
363}
364
822f7c73 365while test $# != 0
1b1dce4b
JS
366do
367 case "$1" in
368 --continue)
369 comment_for_reflog continue
370
371 test -d "$DOTEST" || die "No interactive rebase running"
372
ab119032
JH
373 # Sanity check
374 git rev-parse --verify HEAD >/dev/null ||
375 die "Cannot read HEAD"
376 git update-index --refresh && git diff-files --quiet ||
377 die "Working tree is dirty"
378
379 # do we have anything to commit?
380 if git diff-index --cached --quiet HEAD --
03270628 381 then
ab119032
JH
382 : Nothing to commit -- skip this
383 else
384 . "$DOTEST"/author-script ||
385 die "Cannot find the author identity"
386 if test -f "$DOTEST"/amend
387 then
388 git reset --soft HEAD^ ||
389 die "Cannot rewind the HEAD"
390 fi
391 export GIT_AUTHOR_NAME GIT_AUTHOR_EMAIL GIT_AUTHOR_DATE &&
392 git commit --no-verify -F "$DOTEST"/message -e ||
dbedf972 393 die "Could not commit staged changes."
03270628 394 fi
18640d99 395
1b1dce4b
JS
396 require_clean_work_tree
397 do_rest
398 ;;
399 --abort)
400 comment_for_reflog abort
401
ecfe72ff 402 git rerere clear
1b1dce4b
JS
403 test -d "$DOTEST" || die "No interactive rebase running"
404
405 HEADNAME=$(cat "$DOTEST"/head-name)
406 HEAD=$(cat "$DOTEST"/head)
73697a0b
JS
407 case $HEADNAME in
408 refs/*)
409 git symbolic-ref HEAD $HEADNAME
410 ;;
411 esac &&
dfa49f33 412 output git reset --hard $HEAD &&
1b1dce4b
JS
413 rm -rf "$DOTEST"
414 exit
415 ;;
416 --skip)
417 comment_for_reflog skip
418
ecfe72ff 419 git rerere clear
1b1dce4b
JS
420 test -d "$DOTEST" || die "No interactive rebase running"
421
dfa49f33 422 output git reset --hard && do_rest
1b1dce4b
JS
423 ;;
424 -s|--strategy)
1b1dce4b
JS
425 case "$#,$1" in
426 *,*=*)
b5e960b1 427 STRATEGY="-s "$(expr "z$1" : 'z-[^=]*=\(.*\)') ;;
1b1dce4b
JS
428 1,*)
429 usage ;;
430 *)
431 STRATEGY="-s $2"
432 shift ;;
433 esac
434 ;;
65ae89bc 435 -m|--merge)
1b1dce4b
JS
436 # we use merge anyway
437 ;;
438 -C*)
439 die "Interactive rebase uses merge, so $1 does not make sense"
440 ;;
c54b7817 441 -v|--verbose)
1b1dce4b
JS
442 VERBOSE=t
443 ;;
f09c9b8c
JS
444 -p|--preserve-merges)
445 PRESERVE_MERGES=t
446 ;;
1b1dce4b
JS
447 -i|--interactive)
448 # yeah, we know
449 ;;
450 ''|-h)
451 usage
452 ;;
453 *)
454 test -d "$DOTEST" &&
455 die "Interactive rebase already started"
456
457 git var GIT_COMMITTER_IDENT >/dev/null ||
458 die "You need to set your committer info first"
459
460 comment_for_reflog start
461
462 ONTO=
463 case "$1" in
464 --onto)
465 ONTO=$(git rev-parse --verify "$2") ||
466 die "Does not point to a valid commit: $2"
467 shift; shift
468 ;;
469 esac
470
471 require_clean_work_tree
472
3b38ec16 473 if test ! -z "$2"
1b1dce4b 474 then
dfa49f33 475 output git show-ref --verify --quiet "refs/heads/$2" ||
1b1dce4b 476 die "Invalid branchname: $2"
dfa49f33 477 output git checkout "$2" ||
1b1dce4b
JS
478 die "Could not checkout $2"
479 fi
480
481 HEAD=$(git rev-parse --verify HEAD) || die "No HEAD?"
482 UPSTREAM=$(git rev-parse --verify "$1") || die "Invalid base"
483
5166810b
MK
484 mkdir "$DOTEST" || die "Could not create temporary $DOTEST"
485
1b1dce4b
JS
486 test -z "$ONTO" && ONTO=$UPSTREAM
487
1b1dce4b 488 : > "$DOTEST"/interactive || die "Could not mark as interactive"
73697a0b
JS
489 git symbolic-ref HEAD > "$DOTEST"/head-name 2> /dev/null ||
490 echo "detached HEAD" > "$DOTEST"/head-name
1b1dce4b
JS
491
492 echo $HEAD > "$DOTEST"/head
493 echo $UPSTREAM > "$DOTEST"/upstream
494 echo $ONTO > "$DOTEST"/onto
8e4a91bd 495 test -z "$STRATEGY" || echo "$STRATEGY" > "$DOTEST"/strategy
1b1dce4b 496 test t = "$VERBOSE" && : > "$DOTEST"/verbose
3b38ec16 497 if test t = "$PRESERVE_MERGES"
f09c9b8c
JS
498 then
499 # $REWRITTEN contains files for each commit that is
500 # reachable by at least one merge base of $HEAD and
501 # $UPSTREAM. They are not necessarily rewritten, but
502 # their children might be.
503 # This ensures that commits on merged, but otherwise
504 # unrelated side branches are left alone. (Think "X"
505 # in the man page's example.)
506 mkdir "$REWRITTEN" &&
507 for c in $(git merge-base --all $HEAD $UPSTREAM)
508 do
509 echo $ONTO > "$REWRITTEN"/$c ||
510 die "Could not init rewritten commits"
511 done
512 MERGES_OPTION=
513 else
514 MERGES_OPTION=--no-merges
515 fi
1b1dce4b 516
c54b7817
JS
517 SHORTUPSTREAM=$(git rev-parse --short $UPSTREAM)
518 SHORTHEAD=$(git rev-parse --short $HEAD)
519 SHORTONTO=$(git rev-parse --short $ONTO)
6047a234
JS
520 git rev-list $MERGES_OPTION --pretty=oneline --abbrev-commit \
521 --abbrev=7 --reverse --left-right --cherry-pick \
522 $UPSTREAM...$HEAD | \
523 sed -n "s/^>/pick /p" > "$TODO"
524 cat >> "$TODO" << EOF
525
526# Rebase $SHORTUPSTREAM..$SHORTHEAD onto $SHORTONTO
1b1dce4b
JS
527#
528# Commands:
529# pick = use commit
530# edit = use commit, but stop for amending
531# squash = use commit, but meld into previous commit
82576ddb
JS
532#
533# If you remove a line here THAT COMMIT WILL BE LOST.
6047a234 534# However, if you remove everything, the rebase will be aborted.
82576ddb 535#
1b1dce4b 536EOF
1b1dce4b 537
376ccb8c 538 has_action "$TODO" ||
c54b7817 539 die_abort "Nothing to do"
1b1dce4b
JS
540
541 cp "$TODO" "$TODO".backup
ef0c2abf 542 git_editor "$TODO" ||
1b1dce4b
JS
543 die "Could not execute editor"
544
376ccb8c 545 has_action "$TODO" ||
c54b7817
JS
546 die_abort "Nothing to do"
547
dfa49f33 548 output git checkout $ONTO && do_rest
376ccb8c 549 ;;
1b1dce4b
JS
550 esac
551 shift
552done