Browse files

Merge branch 'tk/doc-filter-branch'

* tk/doc-filter-branch:
  Documentation: filter-branch env-filter example
  git-filter-branch.txt: clarify ident variables usage
  • Loading branch information...
2 parents 118f542 + 21b6e4f commit dbe71f9e24007c41eed76ecc8ae34be010676223 @gitster gitster committed Mar 19, 2013
Showing with 25 additions and 2 deletions.
  1. +25 −2 Documentation/git-filter-branch.txt
27 Documentation/git-filter-branch.txt
@@ -64,8 +64,11 @@ argument is always evaluated in the shell context using the 'eval' command
Prior to that, the $GIT_COMMIT environment variable will be set to contain
the id of the commit being rewritten. Also, GIT_AUTHOR_NAME,
-and GIT_COMMITTER_DATE are set according to the current commit. The values
-of these variables after the filters have run, are used for the new commit.
+and GIT_COMMITTER_DATE are taken from the current commit and exported to
+the environment, in order to affect the author and committer identities of
+the replacement commit created by linkgit:git-commit-tree[1] after the
+filters have run.
If any evaluation of <command> returns a non-zero exit status, the whole
operation will be aborted.
@@ -329,6 +332,26 @@ git filter-branch --msg-filter '
+The `--env-filter` option can be used to modify committer and/or author
+identity. For example, if you found out that your commits have the wrong
+identity due to a misconfigured, you can make a correction,
+before publishing the project, like this:
+git filter-branch --env-filter '
+ if test "$GIT_AUTHOR_EMAIL" = "root@localhost"
+ then
+ fi
+ if test "$GIT_COMMITTER_EMAIL" = "root@localhost"
+ then
+ fi
+' -- --all
To restrict rewriting to only part of the history, specify a revision
range in addition to the new branch name. The new branch name will
point to the top-most revision that a 'git rev-list' of this range

0 comments on commit dbe71f9

Please sign in to comment.