filter-branch: add `--setup` step

A `--setup` step in `git filter-branch` makes it much easier to
define the initial values of variables used in the real filters.
Also sourcing/defining utility functions here instead of
`--env-filter` improves performance and minimizes clogging the
output in case of errors.

Signed-off-by: Andreas Heiduk <asheiduk@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/Documentation/git-filter-branch.txt b/Documentation/git-filter-branch.txt
index 7b695dbb7267bb8ab3497af133331dd8fbb3c147..9e5169aa64f4ffd5ea42f85b2dbe812086e9652c 100644 (file)
--- a/Documentation/git-filter-branch.txt
+++ b/Documentation/git-filter-branch.txt
@@ -8,11 +8,11 @@ git-filter-branch - Rewrite branches
 SYNOPSIS
 --------
 [verse]
 SYNOPSIS
 --------
 [verse]

-'git filter-branch' [--env-filter <command>] [--tree-filter <command>]
-       [--index-filter <command>] [--parent-filter <command>]
-       [--msg-filter <command>] [--commit-filter <command>]
-       [--tag-name-filter <command>] [--subdirectory-filter <directory>]
-       [--prune-empty]
+'git filter-branch' [--setup <command>] [--env-filter <command>]
+       [--tree-filter <command>] [--index-filter <command>]
+       [--parent-filter <command>] [--msg-filter <command>]
+       [--commit-filter <command>] [--tag-name-filter <command>]
+       [--subdirectory-filter <directory>] [--prune-empty]

        [--original <namespace>] [-d <directory>] [-f | --force]
        [--] [<rev-list options>...]
 
        [--original <namespace>] [-d <directory>] [-f | --force]
        [--] [<rev-list options>...]
 


@@ -82,6 +82,13 @@ multiple commits.
 OPTIONS
 -------
 
 OPTIONS
 -------
 

+--setup <command>::
+       This is not a real filter executed for each commit but a one
+       time setup just before the loop. Therefore no commit-specific
+       variables are defined yet.  Functions or variables defined here
+       can be used or modified in the following filter steps except
+       the commit filter, for technical reasons.
+

 --env-filter <command>::
        This filter may be used if you only need to modify the environment
        in which the commit will be performed.  Specifically, you might
 --env-filter <command>::
        This filter may be used if you only need to modify the environment
        in which the commit will be performed.  Specifically, you might

diff --git a/git-filter-branch.sh b/git-filter-branch.sh
index aafaf708dace3493bee23370a6af9535a38e4c99..2758ae5ebf0ed308c3fd4fb28679e387d774bccd 100755 (executable)
--- a/git-filter-branch.sh
+++ b/git-filter-branch.sh
@@ -81,11 +81,12 @@ set_ident () {
        finish_ident COMMITTER
 }
 
        finish_ident COMMITTER
 }
 

-USAGE="[--env-filter <command>] [--tree-filter <command>]
-       [--index-filter <command>] [--parent-filter <command>]
-       [--msg-filter <command>] [--commit-filter <command>]
-       [--tag-name-filter <command>] [--subdirectory-filter <directory>]
-       [--original <namespace>] [-d <directory>] [-f | --force]
+USAGE="[--setup <command>] [--env-filter <command>]
+       [--tree-filter <command>] [--index-filter <command>]
+       [--parent-filter <command>] [--msg-filter <command>]
+       [--commit-filter <command>] [--tag-name-filter <command>]
+       [--subdirectory-filter <directory>] [--original <namespace>]
+       [-d <directory>] [-f | --force]

        [<rev-list options>...]"
 
 OPTIONS_SPEC=
        [<rev-list options>...]"
 
 OPTIONS_SPEC=


@@ -96,6 +97,7 @@ if [ "$(is_bare_repository)" = false ]; then
 fi
 
 tempdir=.git-rewrite
 fi
 
 tempdir=.git-rewrite

+filter_setup=

 filter_env=
 filter_tree=
 filter_index=
 filter_env=
 filter_tree=
 filter_index=


@@ -148,6 +150,9 @@ do
        -d)
                tempdir="$OPTARG"
                ;;
        -d)
                tempdir="$OPTARG"
                ;;

+       --setup)
+               filter_setup="$OPTARG"
+               ;;

        --env-filter)
                filter_env="$OPTARG"
                ;;
        --env-filter)
                filter_env="$OPTARG"
                ;;


@@ -317,6 +322,9 @@ else
        need_index=
 fi
 
        need_index=
 fi
 

+eval "$filter_setup" < /dev/null ||
+       die "filter setup failed: $filter_setup"
+

 while read commit parents; do
        git_filter_branch__commit_count=$(($git_filter_branch__commit_count+1))
 
 while read commit parents; do
        git_filter_branch__commit_count=$(($git_filter_branch__commit_count+1))