3 # Rewrite revision history
4 # Copyright (c) Petr Baudis, 2006
5 # Minimal changes to "port" it to core-git (c) Johannes Schindelin, 2007
7 # Lets you rewrite the revision history of the current branch, creating
8 # a new branch. You can specify a number of filters to modify the commits,
11 # The following functions will also be available in the commit filter:
13 functions
=$
(cat << \EOF
20 # if it was not rewritten, take the original
21 if test -r "$workdir/../map/$1"
23 cat "$workdir/../map/$1"
29 # if you run 'skip_commit "$@"' in a commit filter, it will print
30 # the (mapped) parents, effectively skipping the commit.
43 # if you run 'git_commit_non_empty_tree "$@"' in a commit filter,
44 # it will skip commits that leave the tree untouched, commit the other.
45 git_commit_non_empty_tree
()
47 if test $# = 3 && test "$1" = $
(git rev-parse
"$3^{tree}"); then
53 # override die(): this version puts in an extra line break, so that
54 # the progress is still visible
67 # When piped a commit, output a script to set the ident of either
68 # "author" or "committer
71 lid
="$(echo "$1" | tr "[A-Z
]" "[a-z
]")"
72 uid
="$(echo "$1" | tr "[a-z
]" "[A-Z
]")"
77 s/^'$lid' \([^<]*\) <[^>]*> .*$/\1/
79 s
/.
*/GIT_
'$uid'_NAME
='\''&'\''; export GIT_
'$uid'_NAME
/p
82 s
/^
'$lid' [^
<]* <\
([^
>]*\
)> .
*$
/\
1/
84 s/.*/GIT_'$uid'_EMAIL='\''&'\''; export GIT_'$uid'_EMAIL/p
87 s/^'$lid' [^<]* <[^>]*> \(.*\)$/\1/
89 s
/.
*/GIT_
'$uid'_DATE
='\''&'\''; export GIT_
'$uid'_DATE
/p
95 LANG=C LC_ALL=C sed -ne "$pick_id_script"
96 # Ensure non-empty id name.
97 echo "case \"\$GIT_${uid}_NAME\" in \"\") GIT_${uid}_NAME=\"\${GIT_${uid}_EMAIL%%@*}\" && export GIT_${uid}_NAME;; esac"
100 USAGE="[--env-filter <command>] [--tree-filter <command>]
101 [--index-filter <command>] [--parent-filter <command>]
102 [--msg-filter <command>] [--commit-filter <command>]
103 [--tag-name-filter <command>] [--subdirectory-filter <directory>]
104 [--original <namespace>] [-d <directory>] [-f | --force]
105 [<rev-list options>...]"
110 if [ "$(is_bare_repository)" = false ]; then
111 git diff-files --ignore-submodules --quiet &&
112 git diff-index --cached --quiet HEAD -- ||
113 die "Cannot rewrite branch(es) with a dirty working directory."
125 orig_namespace=refs/original/
151 # all switches take one argument
153 case "$#" in 1) usage ;; esac
166 filter_tree="$OPTARG"
169 filter_index="$OPTARG"
172 filter_parent="$OPTARG"
178 filter_commit="$functions; $OPTARG"
181 filter_tag_name="$OPTARG"
183 --subdirectory-filter)
184 filter_subdir="$OPTARG"
187 orig_namespace=$(expr "$OPTARG/" : '\
(.
*[^
/]\
)/*$
')/
195 case "$prune_empty,$filter_commit" in
197 filter_commit='git commit-tree
"$@"';;
199 filter_commit="$functions;"' git_commit_non_empty_tree
"$@"';;
203 die "Cannot set --prune-empty and --filter-commit at the same time"
211 test -d "$tempdir" &&
212 die "$tempdir already exists, please remove it"
214 mkdir -p "$tempdir/t" &&
215 tempdir="$(cd "$tempdir"; pwd)" &&
220 # Remove tempdir on exit
221 trap 'cd ..
/..
; rm -rf "$tempdir"' 0
223 ORIG_GIT_DIR="$GIT_DIR"
224 ORIG_GIT_WORK_TREE="$GIT_WORK_TREE"
225 ORIG_GIT_INDEX_FILE="$GIT_INDEX_FILE"
227 export GIT_DIR GIT_WORK_TREE
229 # Make sure refs/original is empty
230 git for-each-ref > "$tempdir"/backup-refs || exit
231 while read sha1 type name
233 case "$force,$name" in
235 die "Cannot create a new backup.
236 A previous backup already exists in $orig_namespace
237 Force overwriting the backup with -f"
240 git update-ref -d "$name" $sha1
243 done < "$tempdir"/backup-refs
245 # The refs should be updated if their heads were rewritten
246 git rev-parse --no-flags --revs-only --symbolic-full-name \
247 --default HEAD "$@" > "$tempdir"/raw-heads || exit
248 sed -e '/^^
/d
' "$tempdir"/raw-heads >"$tempdir"/heads
250 test -s "$tempdir"/heads ||
251 die "Which ref do you want to rewrite?"
253 GIT_INDEX_FILE="$(pwd)/../index"
254 export GIT_INDEX_FILE
255 git read-tree || die "Could not seed the index"
257 # map old->new commit ids for rewriting parents
258 mkdir ../map || die "Could not create map/ directory"
260 # we need "--" only if there are no path arguments in $@
261 nonrevs=$(git rev-parse --no-revs "$@") || exit
262 test -z "$nonrevs" && dashdash=-- || dashdash=
263 rev_args=$(git rev-parse --revs-only "$@")
265 case "$filter_subdir" in
267 eval set -- "$(git rev-parse --sq --no-revs "$@")"
270 eval set -- "$(git rev-parse --sq --no-revs "$@" $dashdash \
275 git rev-list --reverse --topo-order --default HEAD \
276 --parents --simplify-merges $rev_args "$@" > ../revs ||
277 die "Could not get the commits"
278 commits=$(wc -l <../revs | tr -d " ")
280 test $commits -eq 0 && die "Found nothing to rewrite"
282 # Rewrite the commits
284 git_filter_branch__commit_count=0
285 while read commit parents; do
286 git_filter_branch__commit_count=$(($git_filter_branch__commit_count+1))
287 printf "\rRewrite $commit ($git_filter_branch__commit_count/$commits)"
289 case "$filter_subdir" in
291 git read-tree -i -m $commit
294 # The commit may not have the subdirectory at all
295 err=$(git read-tree -i -m $commit:"$filter_subdir" 2>&1) || {
296 if ! git rev-parse -q --verify $commit:"$filter_subdir"
298 rm -f "$GIT_INDEX_FILE"
304 esac || die "Could not initialize the index"
308 git cat-file commit "$commit" >../commit ||
309 die "Cannot read commit $commit"
311 eval "$(set_ident AUTHOR <../commit)" ||
312 die "setting author failed for commit $commit"
313 eval "$(set_ident COMMITTER <../commit)" ||
314 die "setting committer failed for commit $commit"
315 eval "$filter_env" < /dev/null ||
316 die "env filter failed: $filter_env"
318 if [ "$filter_tree" ]; then
319 git checkout-index -f -u -a ||
320 die "Could not checkout the index"
321 # files that $commit removed are now still in the working tree;
322 # remove them, else they would be added again
323 git clean -d -q -f -x
324 eval "$filter_tree" < /dev/null ||
325 die "tree filter failed: $filter_tree"
328 git diff-index -r --name-only $commit &&
329 git ls-files --others
330 ) > "$tempdir"/tree-state || exit
331 git update-index --add --replace --remove --stdin \
332 < "$tempdir"/tree-state || exit
335 eval "$filter_index" < /dev/null ||
336 die "index filter failed: $filter_index"
339 for parent in $parents; do
340 for reparent in $(map "$parent"); do
341 parentstr="$parentstr -p $reparent"
344 if [ "$filter_parent" ]; then
345 parentstr="$(echo "$parentstr" | eval "$filter_parent")" ||
346 die "parent filter failed: $filter_parent"
349 sed -e '1,/^$
/d
' <../commit | \
350 eval "$filter_msg" > ../message ||
351 die "msg filter failed: $filter_msg"
352 @SHELL_PATH@ -c "$filter_commit" "git commit-tree" \
353 $(git write-tree) $parentstr < ../message > ../map/$commit ||
354 die "could not write rewritten commit"
357 # In case of a subdirectory filter, it is possible that a specified head
358 # is not in the set of rewritten commits, because it was pruned by the
359 # revision walker. Fix it by mapping these heads to the unique nearest
360 # ancestor that survived the pruning.
362 if test "$filter_subdir"
366 sha1=$(git rev-parse "$ref"^0)
367 test -f "$workdir"/../map/$sha1 && continue
368 ancestor=$(git rev-list --simplify-merges -1 "$ref" "$@")
369 test "$ancestor" && echo $(map $ancestor) >> "$workdir"/../map/$sha1
370 done < "$tempdir"/heads
373 # Finally update the refs
375 _x40='[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f]'
376 _x40="$_x40$_x40$_x40$_x40$_x40$_x40$_x40$_x40"
380 # avoid rewriting a ref twice
381 test -f "$orig_namespace$ref" && continue
383 sha1=$(git rev-parse "$ref"^0)
384 rewritten=$(map $sha1)
386 test $sha1 = "$rewritten" &&
387 warn "WARNING: Ref '$ref' is unchanged" &&
392 echo "Ref '$ref' was deleted"
393 git update-ref -m "filter-branch: delete" -d "$ref" $sha1 ||
394 die "Could not delete $ref"
397 echo "Ref '$ref' was rewritten"
398 if ! git update-ref -m "filter-branch: rewrite" \
399 "$ref" $rewritten $sha1 2>/dev/null; then
400 if test $(git cat-file -t "$ref") = tag; then
401 if test -z "$filter_tag_name"; then
402 warn "WARNING: You said to rewrite tagged commits, but not the corresponding tag."
403 warn "WARNING: Perhaps use '--tag-name-filter cat' to rewrite the tag."
406 die "Could not rewrite $ref"
411 # NEEDSWORK: possibly add -Werror, making this an error
412 warn "WARNING: '$ref' was rewritten into multiple commits:"
414 warn "WARNING: Ref '$ref' points to the first one now."
415 rewritten=$(echo "$rewritten" | head -n 1)
416 git update-ref -m "filter-branch: rewrite to first" \
417 "$ref" $rewritten $sha1 ||
418 die "Could not rewrite $ref"
421 git update-ref -m "filter-branch: backup" "$orig_namespace$ref" $sha1 ||
423 done < "$tempdir"/heads
425 # TODO: This should possibly go, with the semantics that all positive given
426 # refs are updated, and their original heads stored in refs/original/
429 if [ "$filter_tag_name" ]; then
430 git for-each-ref --format='%(objectname
) %(objecttype
) %(refname
)' refs/tags |
431 while read sha1 type ref; do
432 ref="${ref#refs/tags/}"
433 # XXX: Rewrite tagged trees as well?
434 if [ "$type" != "commit" -a "$type" != "tag" ]; then
438 if [ "$type" = "tag" ]; then
439 # Dereference to a commit
441 sha1="$(git rev-parse -q "$sha1"^{commit})" || continue
444 [ -f "../map/$sha1" ] || continue
445 new_sha1="$(cat "../map/$sha1")"
448 new_ref="$(echo "$ref" | eval "$filter_tag_name")" ||
449 die "tag name filter failed: $filter_tag_name"
451 echo "$ref -> $new_ref ($sha1 -> $new_sha1)"
453 if [ "$type" = "tag" ]; then
454 new_sha1=$( ( printf 'object
%s
\ntype commit
\ntag
%s
\n' \
455 "$new_sha1" "$new_ref"
456 git cat-file tag "$ref" |
463 -e '/^
-----BEGIN PGP SIGNATURE----
-/q
' \
466 die "Could not create new tag object for $ref"
467 if git cat-file tag "$ref" | \
468 grep '^
-----BEGIN PGP SIGNATURE-----
' >/dev/null 2>&1
470 warn "gpg signature stripped from tag object $sha1t"
474 git update-ref "refs/tags/$new_ref" "$new_sha1" ||
475 die "Could not write tag $new_ref"
484 unset GIT_DIR GIT_WORK_TREE GIT_INDEX_FILE
485 test -z "$ORIG_GIT_DIR" || {
486 GIT_DIR="$ORIG_GIT_DIR" && export GIT_DIR
488 test -z "$ORIG_GIT_WORK_TREE" || {
489 GIT_WORK_TREE="$ORIG_GIT_WORK_TREE" &&
492 test -z "$ORIG_GIT_INDEX_FILE" || {
493 GIT_INDEX_FILE="$ORIG_GIT_INDEX_FILE" &&
494 export GIT_INDEX_FILE
497 if [ "$(is_bare_repository)" = false ]; then
498 git read-tree -u -m HEAD || exit