From: Tadeusz Andrzej Kadłubowski Date: Thu, 21 Feb 2013 20:22:50 +0000 (+0100) Subject: git-filter-branch.txt: clarify ident variables usage X-Git-Tag: v1.8.1.6~21^2~1 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=bee3eb079d10bd309c75c39efa1e50fbb70931d4;p=git 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 Signed-off-by: Junio C Hamano --- 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 returns a non-zero exit status, the whole operation will be aborted.