Improve description of git filter-branch.
Signed-off-by: Ralf Wildenhues <Ralf.Wildenhues@gmx.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Ralf Wildenhues committed
Mar 20, 2008 at 22:30 UTC
bf7c90216df7f6ac84dee7d30e14c954d48f4718
1 file changed
+12
-11
Documentation/git-filter-branch.txt
+12
-11
@@ -25,7 +25,7 @@ Otherwise, all information (including original commit times or merge
25
information) will be preserved.
26
27
The command will only rewrite the _positive_ refs mentioned in the
28
-command line (i.e. if you pass 'a..b', only 'b' will be rewritten).
28
+command line (e.g. if you pass 'a..b', only 'b' will be rewritten).
29
If you specify no filters, the commits will be recommitted without any
30
changes, which would normally have no effect. Nevertheless, this may be
31
useful in the future for compensating for some git bugs or such,
@@ -42,7 +42,7 @@ Always verify that the rewritten version is correct: The original refs,
42
if different from the rewritten ones, will be stored in the namespace
43
'refs/original/'.
44
45
-Note that since this operation is extensively I/O expensive, it might
45
+Note that since this operation is very I/O expensive, it might
46
be a good idea to redirect the temporary directory off-disk with the
47
'-d' option, e.g. on tmpfs. Reportedly the speedup is very noticeable.
48
@@ -51,14 +51,15 @@ Filters
51
~~~~~~~
52
53
The filters are applied in the order as listed below. The <command>
54
-argument is always evaluated in shell using the 'eval' command (with the
55
-notable exception of the commit filter, for technical reasons).
54
+argument is always evaluated in the shell context using the 'eval' command
55
+(with the notable exception of the commit filter, for technical reasons).
56
Prior to that, the $GIT_COMMIT environment variable will be set to contain
57
the id of the commit being rewritten. Also, GIT_AUTHOR_NAME,
58
GIT_AUTHOR_EMAIL, GIT_AUTHOR_DATE, GIT_COMMITTER_NAME, GIT_COMMITTER_EMAIL,
59
-and GIT_COMMITTER_DATE are set according to the current commit. If any
60
-evaluation of <command> returns a non-zero exit status, the whole operation
61
-will be aborted.
59
+and GIT_COMMITTER_DATE are set according to the current commit. The values
60
+of these variables after the filters have run, are used for the new commit.
61
+If any evaluation of <command> returns a non-zero exit status, the whole
62
+operation will be aborted.
63
64
A 'map' function is available that takes an "original sha1 id" argument
65
and outputs a "rewritten sha1 id" if the commit has been already
@@ -71,9 +72,9 @@ OPTIONS
72
-------
73
74
--env-filter <command>::
74
- This is the filter for modifying the environment in which
75
- the commit will be performed. Specifically, you might want
76
- to rewrite the author/committer name/email/time environment
75
+ This filter may be used if you only need to modify the environment
76
+ in which the commit will be performed. Specifically, you might
77
+ want to rewrite the author/committer name/email/time environment
78
variables (see linkgit:git-commit[1] for details). Do not forget
79
to re-export the variables.
80
@@ -149,7 +150,7 @@ definition impossible to preserve signatures at any rate.)
150
-d <directory>::
151
Use this option to set the path to the temporary directory used for
152
rewriting. When applying a tree filter, the command needs to
152
- temporary checkout the tree to some directory, which may consume
153
+ temporarily check out the tree to some directory, which may consume
154
considerable space in case of large projects. By default it
155
does this in the '.git-rewrite/' directory but you can override
156
that choice by this parameter.