Skip to content

Commit bee3eb0

Browse files
tkadlubogitster
authored andcommitted
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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 8093ae8 commit bee3eb0

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

Documentation/git-filter-branch.txt

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,11 @@ argument is always evaluated in the shell context using the 'eval' command
6464
Prior to that, the $GIT_COMMIT environment variable will be set to contain
6565
the id of the commit being rewritten. Also, GIT_AUTHOR_NAME,
6666
GIT_AUTHOR_EMAIL, GIT_AUTHOR_DATE, GIT_COMMITTER_NAME, GIT_COMMITTER_EMAIL,
67-
and GIT_COMMITTER_DATE are set according to the current commit. The values
68-
of these variables after the filters have run, are used for the new commit.
67+
and GIT_COMMITTER_DATE are taken from the current commit and exported to
68+
the environment, in order to affect the author and committer identities of
69+
the replacement commit created by linkgit:git-commit-tree[1] after the
70+
filters have run.
71+
6972
If any evaluation of <command> returns a non-zero exit status, the whole
7073
operation will be aborted.
7174

0 commit comments

Comments
 (0)