Autogenerated HTML docs for v1.5.3-rc7-30-g947ad2

1 files changed, 38 insertions, 22 deletions

diff --git a/git-filter-branch.html b/git-filter-branch.html
index 2a3baf81b..84ed10364 100644
--- a/git-filter-branch.html
+++ b/git-filter-branch.html
@@ -282,18 +282,18 @@ git-filter-branch(1) Manual Page
 </div>

 <h2>DESCRIPTION</h2>

 <div class="sectionbody">

-<p>Lets you rewrite git revision history by creating a new branch from

-your current branch, applying custom filters on each revision.

+<p>Lets you rewrite git revision history by rewriting the branches mentioned

+in the &lt;rev-list options&gt;, applying custom filters on each revision.

 Those filters can modify each tree (e.g. removing a file or running

 a perl rewrite on all files) or information about each commit.

 Otherwise, all information (including original commit times or merge

 information) will be preserved.</p>

-<p>The command takes the new branch name as a mandatory argument and

-the filters as optional arguments.  If you specify no filters, the

-commits will be recommitted without any changes, which would normally

-have no effect.  Nevertheless, this may be useful in the future for

-compensating for some git bugs or such, therefore such a usage is

-permitted.</p>

+<p>The command will only rewrite the _positive_ refs mentioned in the

+command line (i.e. if you pass <em>a..b</em>, only <em>b</em> will be rewritten).

+If you specify no filters, the commits will be recommitted without any

+changes, which would normally have no effect.  Nevertheless, this may be

+useful in the future for compensating for some git bugs or such,

+therefore such a usage is permitted.</p>

 <p><strong>WARNING</strong>! The rewritten history will have different object names for all

 the objects and will not converge with the original branch.  You will not

 be able to easily push and distribute the rewritten branch on top of the

@@ -304,8 +304,8 @@ would suffice to fix your problem.</p>
 if different from the rewritten ones, will be stored in the namespace

 <em>refs/original/</em>.</p>

 <p>Note that since this operation is extensively I/O expensive, it might

-be a good idea to redirect the temporary directory off-disk, e.g. on

-tmpfs.  Reportedly the speedup is very noticeable.</p>

+be a good idea to redirect the temporary directory off-disk with the

+<em>-d</em> option, e.g. on tmpfs.  Reportedly the speedup is very noticeable.</p>

 <h3>Filters</h3>

 <p>The filters are applied in the order as listed below.  The &lt;command&gt;

 argument is always evaluated in shell using the <em>eval</em> command (with the

@@ -396,6 +396,10 @@ multiple commits.</p>
 <p>As a special extension, the commit filter may emit multiple

 commit ids; in that case, ancestors of the original commit will

 have all of them as parents.</p>

+<p>You can use the <em>map</em> convenience function in this filter, and other

+convenience functions, too.  For example, calling <em>skip_commit "$@"</em>

+will leave out the current commit (but not its changes! If you want

+that, use <a href="git-rebase.html">git-rebase(1)</a> instead).</p>

 </dd>

 <dt>

 --tag-name-filter &lt;command&gt;

@@ -494,8 +498,8 @@ order to paste the other history behind the current history:</p>
 <div class="content">

 <pre><tt>git filter-branch --parent-filter 'sed "s/^\$/-p &lt;graft-id&gt;/"' HEAD</tt></pre>

 </div></div>

-<p>(if the parent string is empty - therefore we are dealing with the

-initial commit - add graftcommit as a parent).  Note that this assumes

+<p>(if the parent string is empty - which happens when we are dealing with

+the initial commit - add graftcommit as a parent).  Note that this assumes

 history with a single root (that is, no merge without common ancestors

 happened).  If this is not the case, use:</p>

 <div class="listingblock">

@@ -515,17 +519,29 @@ git filter-branch $graft-id..HEAD</tt></pre>
 <pre><tt>git filter-branch --commit-filter '

         if [ "$GIT_AUTHOR_NAME" = "Darl McBribe" ];

         then

-                shift;

-                while [ -n "$1" ];

-                do

-                        shift;

-                        echo "$1";

-                        shift;

-                done;

+                skip_commit "$@";

         else

                 git commit-tree "$@";

         fi' HEAD</tt></pre>

 </div></div>

+<p>Note that the changes introduced by the commits, and not reverted by

+subsequent commits, will still be in the rewritten branch. If you want

+to throw out _changes_ together with the commits, you should use the

+interactive mode of <a href="git-rebase.html">git-rebase(1)</a>.</p>

+<p>The function <em>skip_commits</em> is defined as follows:</p>

+<div class="listingblock">

+<div class="content">

+<pre><tt>skip_commit()

+{

+        shift;

+        while [ -n "$1" ];

+        do

+                shift;

+                map "$1";

+                shift;

+        done;

+}</tt></pre>

+</div></div>

 <p>The shift magic first throws away the tree id and then the -p

 parameters.  Note that this handles merges properly! In case Darl

 committed a merge between P1 and P2, it will be propagated properly

@@ -535,8 +551,8 @@ as their parents instead of the merge commit.</p>
 range in addition to the new branch name.  The new branch name will

 point to the top-most revision that a <em>git rev-list</em> of this range

 will print.</p>

-<p>Note that the changes introduced by the commits, and not reverted by

-subsequent commits, will still be in the rewritten branch. If you want

+<p><strong>NOTE</strong> the changes introduced by the commits, and which are not reverted

+by subsequent commits, will still be in the rewritten branch. If you want

 to throw out _changes_ together with the commits, you should use the

 interactive mode of <a href="git-rebase.html">git-rebase(1)</a>.</p>

 <p>Consider this history:</p>

@@ -582,7 +598,7 @@ and the git list &lt;git@vger.kernel.org&gt;</p>
 </div>

 <div id="footer">

 <div id="footer-text">

-Last updated 31-Aug-2007 07:55:56 UTC

+Last updated 01-Sep-2007 11:16:25 UTC

 </div>

 </div>

 </body>