aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/git-filter-branch.txt
diff options
context:
space:
mode:
authorKevin Ballard <kevin@sb.org>2008-05-30 14:43:40 -0700
committerJunio C Hamano <gitster@pobox.com>2008-06-02 20:36:09 -0700
commitc5833f6e1373e4e6a2c31a0cb6cd9050dc395643 (patch)
tree0519f4b16e17e7e728da02c732814fad505e006c /Documentation/git-filter-branch.txt
parentf70dda250e33dd17f6fdff17d15287391d8b0952 (diff)
downloadgit-c5833f6e1373e4e6a2c31a0cb6cd9050dc395643.tar.gz
Documentation/git-filter-branch.txt: Fix description of --commit-filter
The old description was misleading and logically impossible. It claimed that the ancestors of the original commit would be re-written to have the multiple emitted ids as parents. Not only would this modify existing objects, but it would create a cycle. What this actually does is pass the multiple emitted ids to the newly-created children to use as parents. Signed-off-by: Kevin Ballard <kevin@sb.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-filter-branch.txt')
-rw-r--r--Documentation/git-filter-branch.txt2
1 files changed, 1 insertions, 1 deletions
diff --git a/Documentation/git-filter-branch.txt b/Documentation/git-filter-branch.txt
index 506c37af70..35cb1677f7 100644
--- a/Documentation/git-filter-branch.txt
+++ b/Documentation/git-filter-branch.txt
@@ -113,7 +113,7 @@ OPTIONS
stdin. The commit id is expected on stdout.
+
As a special extension, the commit filter may emit multiple
-commit ids; in that case, ancestors of the original commit will
+commit ids; in that case, the rewritten children of the original commit will
have all of them as parents.
+
You can use the 'map' convenience function in this filter, and other