[PATCH] filter-branch documentation: clarify which filters are eval'ed
All filters, except the commit filter, are evaluated.
Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
---
I tried to extract the magic of the "remove commit" example into a
function "skip_commit", since I guess it will be a common
operation. Alas, since the commit filter has to be "sh -c"ed to
get arguments, I do not see any way to use a convenience function
in there, short of sourcing a helper file. Does anybody see a
better way?
Documentation/git-filter-branch.txt | 3 ++-
1 files changed, 2 insertions(+), 1 deletions(-)
diff --git a/Documentation/git-filter-branch.txt b/Documentation/git-filter-branch.txt
index 219a81d..eaea82d 100644
--- a/Documentation/git-filter-branch.txt
+++ b/Documentation/git-filter-branch.txt
@@ -50,7 +50,8 @@ Filters
~~~~~~~
The filters are applied in the order as listed below. The <command>
-argument is always evaluated in shell using the 'eval' command.
+argument is always evaluated in shell using the 'eval' command (with the
+notable exception of the commit filter, for technical reasons).
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,
--
1.5.3.rc0.2689.g99ca2-dirty
Johannes Schindelin <johannes.schindelin@gmx.de>