git-filter-branch.shon commit Documentation: Remove spurious uses of "you" in git-bisect.txt. (19fa5e8)
   1#!/bin/sh
   2#
   3# Rewrite revision history
   4# Copyright (c) Petr Baudis, 2006
   5# Minimal changes to "port" it to core-git (c) Johannes Schindelin, 2007
   6#
   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,
   9# files and trees.
  10
  11# The following functions will also be available in the commit filter:
  12
  13functions=$(cat << \EOF
  14warn () {
  15        echo "$*" >&2
  16}
  17
  18map()
  19{
  20        # if it was not rewritten, take the original
  21        if test -r "$workdir/../map/$1"
  22        then
  23                cat "$workdir/../map/$1"
  24        else
  25                echo "$1"
  26        fi
  27}
  28
  29# if you run 'skip_commit "$@"' in a commit filter, it will print
  30# the (mapped) parents, effectively skipping the commit.
  31
  32skip_commit()
  33{
  34        shift;
  35        while [ -n "$1" ];
  36        do
  37                shift;
  38                map "$1";
  39                shift;
  40        done;
  41}
  42
  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.
  45git_commit_non_empty_tree()
  46{
  47        if test $# = 3 && test "$1" = $(git rev-parse "$3^{tree}"); then
  48                map "$3"
  49        else
  50                git commit-tree "$@"
  51        fi
  52}
  53# override die(): this version puts in an extra line break, so that
  54# the progress is still visible
  55
  56die()
  57{
  58        echo >&2
  59        echo "$*" >&2
  60        exit 1
  61}
  62EOF
  63)
  64
  65eval "$functions"
  66
  67# When piped a commit, output a script to set the ident of either
  68# "author" or "committer
  69
  70set_ident () {
  71        lid="$(echo "$1" | tr "[A-Z]" "[a-z]")"
  72        uid="$(echo "$1" | tr "[a-z]" "[A-Z]")"
  73        pick_id_script='
  74                /^'$lid' /{
  75                        s/'\''/'\''\\'\'\''/g
  76                        h
  77                        s/^'$lid' \([^<]*\) <[^>]*> .*$/\1/
  78                        s/'\''/'\''\'\'\''/g
  79                        s/.*/GIT_'$uid'_NAME='\''&'\''; export GIT_'$uid'_NAME/p
  80
  81                        g
  82                        s/^'$lid' [^<]* <\([^>]*\)> .*$/\1/
  83                        s/'\''/'\''\'\'\''/g
  84                        s/.*/GIT_'$uid'_EMAIL='\''&'\''; export GIT_'$uid'_EMAIL/p
  85
  86                        g
  87                        s/^'$lid' [^<]* <[^>]*> \(.*\)$/\1/
  88                        s/'\''/'\''\'\'\''/g
  89                        s/.*/GIT_'$uid'_DATE='\''&'\''; export GIT_'$uid'_DATE/p
  90
  91                        q
  92                }
  93        '
  94
  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"
  98}
  99
 100USAGE="[--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>...]"
 106
 107OPTIONS_SPEC=
 108. git-sh-setup
 109
 110if [ "$(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."
 114fi
 115
 116tempdir=.git-rewrite
 117filter_env=
 118filter_tree=
 119filter_index=
 120filter_parent=
 121filter_msg=cat
 122filter_commit=
 123filter_tag_name=
 124filter_subdir=
 125orig_namespace=refs/original/
 126force=
 127prune_empty=
 128while :
 129do
 130        case "$1" in
 131        --)
 132                shift
 133                break
 134                ;;
 135        --force|-f)
 136                shift
 137                force=t
 138                continue
 139                ;;
 140        --prune-empty)
 141                shift
 142                prune_empty=t
 143                continue
 144                ;;
 145        -*)
 146                ;;
 147        *)
 148                break;
 149        esac
 150
 151        # all switches take one argument
 152        ARG="$1"
 153        case "$#" in 1) usage ;; esac
 154        shift
 155        OPTARG="$1"
 156        shift
 157
 158        case "$ARG" in
 159        -d)
 160                tempdir="$OPTARG"
 161                ;;
 162        --env-filter)
 163                filter_env="$OPTARG"
 164                ;;
 165        --tree-filter)
 166                filter_tree="$OPTARG"
 167                ;;
 168        --index-filter)
 169                filter_index="$OPTARG"
 170                ;;
 171        --parent-filter)
 172                filter_parent="$OPTARG"
 173                ;;
 174        --msg-filter)
 175                filter_msg="$OPTARG"
 176                ;;
 177        --commit-filter)
 178                filter_commit="$functions; $OPTARG"
 179                ;;
 180        --tag-name-filter)
 181                filter_tag_name="$OPTARG"
 182                ;;
 183        --subdirectory-filter)
 184                filter_subdir="$OPTARG"
 185                ;;
 186        --original)
 187                orig_namespace=$(expr "$OPTARG/" : '\(.*[^/]\)/*$')/
 188                ;;
 189        *)
 190                usage
 191                ;;
 192        esac
 193done
 194
 195case "$prune_empty,$filter_commit" in
 196,)
 197        filter_commit='git commit-tree "$@"';;
 198t,)
 199        filter_commit="$functions;"' git_commit_non_empty_tree "$@"';;
 200,*)
 201        ;;
 202*)
 203        die "Cannot set --prune-empty and --filter-commit at the same time"
 204esac
 205
 206case "$force" in
 207t)
 208        rm -rf "$tempdir"
 209;;
 210'')
 211        test -d "$tempdir" &&
 212                die "$tempdir already exists, please remove it"
 213esac
 214mkdir -p "$tempdir/t" &&
 215tempdir="$(cd "$tempdir"; pwd)" &&
 216cd "$tempdir/t" &&
 217workdir="$(pwd)" ||
 218die ""
 219
 220# Remove tempdir on exit
 221trap 'cd ../..; rm -rf "$tempdir"' 0
 222
 223ORIG_GIT_DIR="$GIT_DIR"
 224ORIG_GIT_WORK_TREE="$GIT_WORK_TREE"
 225ORIG_GIT_INDEX_FILE="$GIT_INDEX_FILE"
 226GIT_WORK_TREE=.
 227export GIT_DIR GIT_WORK_TREE
 228
 229# Make sure refs/original is empty
 230git for-each-ref > "$tempdir"/backup-refs || exit
 231while read sha1 type name
 232do
 233        case "$force,$name" in
 234        ,$orig_namespace*)
 235                die "Namespace $orig_namespace not empty"
 236        ;;
 237        t,$orig_namespace*)
 238                git update-ref -d "$name" $sha1
 239        ;;
 240        esac
 241done < "$tempdir"/backup-refs
 242
 243# The refs should be updated if their heads were rewritten
 244git rev-parse --no-flags --revs-only --symbolic-full-name \
 245        --default HEAD "$@" > "$tempdir"/raw-heads || exit
 246sed -e '/^^/d' "$tempdir"/raw-heads >"$tempdir"/heads
 247
 248test -s "$tempdir"/heads ||
 249        die "Which ref do you want to rewrite?"
 250
 251GIT_INDEX_FILE="$(pwd)/../index"
 252export GIT_INDEX_FILE
 253git read-tree || die "Could not seed the index"
 254
 255# map old->new commit ids for rewriting parents
 256mkdir ../map || die "Could not create map/ directory"
 257
 258case "$filter_subdir" in
 259"")
 260        git rev-list --reverse --topo-order --default HEAD \
 261                --parents --simplify-merges "$@"
 262        ;;
 263*)
 264        git rev-list --reverse --topo-order --default HEAD \
 265                --parents --simplify-merges "$@" -- "$filter_subdir"
 266esac > ../revs || die "Could not get the commits"
 267commits=$(wc -l <../revs | tr -d " ")
 268
 269test $commits -eq 0 && die "Found nothing to rewrite"
 270
 271# Rewrite the commits
 272
 273i=0
 274while read commit parents; do
 275        i=$(($i+1))
 276        printf "\rRewrite $commit ($i/$commits)"
 277
 278        case "$filter_subdir" in
 279        "")
 280                git read-tree -i -m $commit
 281                ;;
 282        *)
 283                # The commit may not have the subdirectory at all
 284                err=$(git read-tree -i -m $commit:"$filter_subdir" 2>&1) || {
 285                        if ! git rev-parse -q --verify $commit:"$filter_subdir"
 286                        then
 287                                rm -f "$GIT_INDEX_FILE"
 288                        else
 289                                echo >&2 "$err"
 290                                false
 291                        fi
 292                }
 293        esac || die "Could not initialize the index"
 294
 295        GIT_COMMIT=$commit
 296        export GIT_COMMIT
 297        git cat-file commit "$commit" >../commit ||
 298                die "Cannot read commit $commit"
 299
 300        eval "$(set_ident AUTHOR <../commit)" ||
 301                die "setting author failed for commit $commit"
 302        eval "$(set_ident COMMITTER <../commit)" ||
 303                die "setting committer failed for commit $commit"
 304        eval "$filter_env" < /dev/null ||
 305                die "env filter failed: $filter_env"
 306
 307        if [ "$filter_tree" ]; then
 308                git checkout-index -f -u -a ||
 309                        die "Could not checkout the index"
 310                # files that $commit removed are now still in the working tree;
 311                # remove them, else they would be added again
 312                git clean -d -q -f -x
 313                eval "$filter_tree" < /dev/null ||
 314                        die "tree filter failed: $filter_tree"
 315
 316                (
 317                        git diff-index -r --name-only $commit &&
 318                        git ls-files --others
 319                ) > "$tempdir"/tree-state || exit
 320                git update-index --add --replace --remove --stdin \
 321                        < "$tempdir"/tree-state || exit
 322        fi
 323
 324        eval "$filter_index" < /dev/null ||
 325                die "index filter failed: $filter_index"
 326
 327        parentstr=
 328        for parent in $parents; do
 329                for reparent in $(map "$parent"); do
 330                        parentstr="$parentstr -p $reparent"
 331                done
 332        done
 333        if [ "$filter_parent" ]; then
 334                parentstr="$(echo "$parentstr" | eval "$filter_parent")" ||
 335                                die "parent filter failed: $filter_parent"
 336        fi
 337
 338        sed -e '1,/^$/d' <../commit | \
 339                eval "$filter_msg" > ../message ||
 340                        die "msg filter failed: $filter_msg"
 341        @SHELL_PATH@ -c "$filter_commit" "git commit-tree" \
 342                $(git write-tree) $parentstr < ../message > ../map/$commit ||
 343                        die "could not write rewritten commit"
 344done <../revs
 345
 346# In case of a subdirectory filter, it is possible that a specified head
 347# is not in the set of rewritten commits, because it was pruned by the
 348# revision walker.  Fix it by mapping these heads to the unique nearest
 349# ancestor that survived the pruning.
 350
 351if test "$filter_subdir"
 352then
 353        while read ref
 354        do
 355                sha1=$(git rev-parse "$ref"^0)
 356                test -f "$workdir"/../map/$sha1 && continue
 357                ancestor=$(git rev-list --simplify-merges -1 \
 358                                $ref -- "$filter_subdir")
 359                test "$ancestor" && echo $(map $ancestor) >> "$workdir"/../map/$sha1
 360        done < "$tempdir"/heads
 361fi
 362
 363# Finally update the refs
 364
 365_x40='[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f]'
 366_x40="$_x40$_x40$_x40$_x40$_x40$_x40$_x40$_x40"
 367echo
 368while read ref
 369do
 370        # avoid rewriting a ref twice
 371        test -f "$orig_namespace$ref" && continue
 372
 373        sha1=$(git rev-parse "$ref"^0)
 374        rewritten=$(map $sha1)
 375
 376        test $sha1 = "$rewritten" &&
 377                warn "WARNING: Ref '$ref' is unchanged" &&
 378                continue
 379
 380        case "$rewritten" in
 381        '')
 382                echo "Ref '$ref' was deleted"
 383                git update-ref -m "filter-branch: delete" -d "$ref" $sha1 ||
 384                        die "Could not delete $ref"
 385        ;;
 386        $_x40)
 387                echo "Ref '$ref' was rewritten"
 388                if ! git update-ref -m "filter-branch: rewrite" \
 389                                        "$ref" $rewritten $sha1 2>/dev/null; then
 390                        if test $(git cat-file -t "$ref") = tag; then
 391                                if test -z "$filter_tag_name"; then
 392                                        warn "WARNING: You said to rewrite tagged commits, but not the corresponding tag."
 393                                        warn "WARNING: Perhaps use '--tag-name-filter cat' to rewrite the tag."
 394                                fi
 395                        else
 396                                die "Could not rewrite $ref"
 397                        fi
 398                fi
 399        ;;
 400        *)
 401                # NEEDSWORK: possibly add -Werror, making this an error
 402                warn "WARNING: '$ref' was rewritten into multiple commits:"
 403                warn "$rewritten"
 404                warn "WARNING: Ref '$ref' points to the first one now."
 405                rewritten=$(echo "$rewritten" | head -n 1)
 406                git update-ref -m "filter-branch: rewrite to first" \
 407                                "$ref" $rewritten $sha1 ||
 408                        die "Could not rewrite $ref"
 409        ;;
 410        esac
 411        git update-ref -m "filter-branch: backup" "$orig_namespace$ref" $sha1 ||
 412                 exit
 413done < "$tempdir"/heads
 414
 415# TODO: This should possibly go, with the semantics that all positive given
 416#       refs are updated, and their original heads stored in refs/original/
 417# Filter tags
 418
 419if [ "$filter_tag_name" ]; then
 420        git for-each-ref --format='%(objectname) %(objecttype) %(refname)' refs/tags |
 421        while read sha1 type ref; do
 422                ref="${ref#refs/tags/}"
 423                # XXX: Rewrite tagged trees as well?
 424                if [ "$type" != "commit" -a "$type" != "tag" ]; then
 425                        continue;
 426                fi
 427
 428                if [ "$type" = "tag" ]; then
 429                        # Dereference to a commit
 430                        sha1t="$sha1"
 431                        sha1="$(git rev-parse "$sha1"^{commit} 2>/dev/null)" || continue
 432                fi
 433
 434                [ -f "../map/$sha1" ] || continue
 435                new_sha1="$(cat "../map/$sha1")"
 436                GIT_COMMIT="$sha1"
 437                export GIT_COMMIT
 438                new_ref="$(echo "$ref" | eval "$filter_tag_name")" ||
 439                        die "tag name filter failed: $filter_tag_name"
 440
 441                echo "$ref -> $new_ref ($sha1 -> $new_sha1)"
 442
 443                if [ "$type" = "tag" ]; then
 444                        new_sha1=$( ( printf 'object %s\ntype commit\ntag %s\n' \
 445                                                "$new_sha1" "$new_ref"
 446                                git cat-file tag "$ref" |
 447                                sed -n \
 448                                    -e "1,/^$/{
 449                                          /^object /d
 450                                          /^type /d
 451                                          /^tag /d
 452                                        }" \
 453                                    -e '/^-----BEGIN PGP SIGNATURE-----/q' \
 454                                    -e 'p' ) |
 455                                git mktag) ||
 456                                die "Could not create new tag object for $ref"
 457                        if git cat-file tag "$ref" | \
 458                           grep '^-----BEGIN PGP SIGNATURE-----' >/dev/null 2>&1
 459                        then
 460                                warn "gpg signature stripped from tag object $sha1t"
 461                        fi
 462                fi
 463
 464                git update-ref "refs/tags/$new_ref" "$new_sha1" ||
 465                        die "Could not write tag $new_ref"
 466        done
 467fi
 468
 469cd ../..
 470rm -rf "$tempdir"
 471
 472trap - 0
 473
 474unset GIT_DIR GIT_WORK_TREE GIT_INDEX_FILE
 475test -z "$ORIG_GIT_DIR" || {
 476        GIT_DIR="$ORIG_GIT_DIR" && export GIT_DIR
 477}
 478test -z "$ORIG_GIT_WORK_TREE" || {
 479        GIT_WORK_TREE="$ORIG_GIT_WORK_TREE" &&
 480        export GIT_WORK_TREE
 481}
 482test -z "$ORIG_GIT_INDEX_FILE" || {
 483        GIT_INDEX_FILE="$ORIG_GIT_INDEX_FILE" &&
 484        export GIT_INDEX_FILE
 485}
 486
 487if [ "$(is_bare_repository)" = false ]; then
 488        git read-tree -u -m HEAD || exit
 489fi
 490
 491exit 0