From: Jon Loeliger <jdl@jdl.com>
Date: Fri, 16 May 2008 19:43:50 +0000 (-0500)
Subject: git-filter-branch: Clarify file removal example.
X-Git-Tag: v1.5.5.2~5
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=e4d594c6bdcb25b996120fe21c901af7a08a7f6d;p=git.git

git-filter-branch: Clarify file removal example.

Signed-off-by: Jon Loeliger <jdl@jdl.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
---

diff --git a/Documentation/git-filter-branch.txt b/Documentation/git-filter-branch.txt
index 6454e49bf..4a530965e 100644
--- a/Documentation/git-filter-branch.txt
+++ b/Documentation/git-filter-branch.txt
@@ -177,6 +177,10 @@ or copyright violation) from all commits:
 git filter-branch --tree-filter 'rm filename' HEAD
 -------------------------------------------------------
 
+However, if the file is absent from the tree of some commit,
+a simple `rm filename` will fail for that tree and commit.
+Thus you may instead want to use `rm -f filename` as the script.
+
 A significantly faster version:
 
 --------------------------------------------------------------------------