aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/git-filter-branch.txt
diff options
context:
space:
mode:
authorTadeusz Andrzej Kadłubowski <yess@hell.org.pl>2013-02-21 21:22:50 +0100
committerJunio C Hamano <gitster@pobox.com>2013-02-26 09:34:51 -0800
commitbee3eb079d10bd309c75c39efa1e50fbb70931d4 (patch)
treed124225dec997a598a9aede3ffe8f9ad34abc5d5 /Documentation/git-filter-branch.txt
parent8093ae8854a50edf44e47c0390d3021ffd07bc00 (diff)
downloadgit-bee3eb079d10bd309c75c39efa1e50fbb70931d4.tar.gz
git-filter-branch.txt: clarify ident variables usage
There is a rare edge case of git-filter-branch: a filter that unsets identity variables from the environment. Link to git-commit-tree clarifies how Git would fall back in this situation. Signed-off-by: Tadeusz Andrzej Kadłubowski <yess@hell.org.pl> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-filter-branch.txt')
-rw-r--r--Documentation/git-filter-branch.txt7
1 files changed, 5 insertions, 2 deletions
diff --git a/Documentation/git-filter-branch.txt b/Documentation/git-filter-branch.txt
index e2301f5c01..c915d0570d 100644
--- a/Documentation/git-filter-branch.txt
+++ b/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,
GIT_AUTHOR_EMAIL, GIT_AUTHOR_DATE, GIT_COMMITTER_NAME, GIT_COMMITTER_EMAIL,
-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.