updated git doc

[TortoiseGit.git] / doc / source / en / TortoiseGit / git_doc / git-filter-branch.xml

<?xml version="1.0" encoding="UTF-8"?>\r
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">\r
\r
<article lang="en" id="git-filter-branch(1)">\r
<articleinfo>\r
    <title>git-filter-branch(1)</title>\r
<indexterm>\r
<primary>git-filter-branch(1)</primary>\r
</indexterm>\r
</articleinfo>\r
<simplesect id="_name">\r
<title>NAME</title>\r
<simpara>git-filter-branch - Rewrite branches</simpara>\r
</simplesect>\r
<simplesect id="_synopsis">\r
<title>SYNOPSIS</title>\r
<blockquote>\r
<literallayout><emphasis>git filter-branch</emphasis> [--env-filter &lt;command&gt;] [--tree-filter &lt;command&gt;]\r
        [--index-filter &lt;command&gt;] [--parent-filter &lt;command&gt;]\r
        [--msg-filter &lt;command&gt;] [--commit-filter &lt;command&gt;]\r
        [--tag-name-filter &lt;command&gt;] [--subdirectory-filter &lt;directory&gt;]\r
        [--prune-empty]\r
        [--original &lt;namespace&gt;] [-d &lt;directory&gt;] [-f | --force]\r
        [--] [&lt;rev-list options&gt;&#8230;]</literallayout>\r
</blockquote>\r
</simplesect>\r
<simplesect id="_description">\r
<title>DESCRIPTION</title>\r
<simpara>Lets you rewrite git revision history by rewriting the branches mentioned\r
in the &lt;rev-list options&gt;, applying custom filters on each revision.\r
Those filters can modify each tree (e.g. removing a file or running\r
a perl rewrite on all files) or information about each commit.\r
Otherwise, all information (including original commit times or merge\r
information) will be preserved.</simpara>\r
<simpara>The command will only rewrite the <emphasis>positive</emphasis> refs mentioned in the\r
command line (e.g. if you pass <emphasis>a..b</emphasis>, only <emphasis>b</emphasis> will be rewritten).\r
If you specify no filters, the commits will be recommitted without any\r
changes, which would normally have no effect.  Nevertheless, this may be\r
useful in the future for compensating for some git bugs or such,\r
therefore such a usage is permitted.</simpara>\r
<simpara><emphasis role="strong">NOTE</emphasis>: This command honors <emphasis>.git/info/grafts</emphasis> and <emphasis>.git/refs/replace/</emphasis>.\r
If you have any grafts or replacement refs defined, running this command\r
will make them permanent.</simpara>\r
<simpara><emphasis role="strong">WARNING</emphasis>! The rewritten history will have different object names for all\r
the objects and will not converge with the original branch.  You will not\r
be able to easily push and distribute the rewritten branch on top of the\r
original branch.  Please do not use this command if you do not know the\r
full implications, and avoid using it anyway, if a simple single commit\r
would suffice to fix your problem.  (See the "RECOVERING FROM UPSTREAM\r
REBASE" section in <xref linkend="git-rebase(1)" /> for further information about\r
rewriting published history.)</simpara>\r
<simpara>Always verify that the rewritten version is correct: The original refs,\r
if different from the rewritten ones, will be stored in the namespace\r
<emphasis>refs/original/</emphasis>.</simpara>\r
<simpara>Note that since this operation is very I/O expensive, it might\r
be a good idea to redirect the temporary directory off-disk with the\r
<emphasis>-d</emphasis> option, e.g. on tmpfs.  Reportedly the speedup is very noticeable.</simpara>\r
<section id="_filters">\r
<title>Filters</title>\r
<simpara>The filters are applied in the order as listed below.  The &lt;command&gt;\r
argument is always evaluated in the shell context using the <emphasis>eval</emphasis> command\r
(with the notable exception of the commit filter, for technical reasons).\r
Prior to that, the $GIT_COMMIT environment variable will be set to contain\r
the id of the commit being rewritten.  Also, GIT_AUTHOR_NAME,\r
GIT_AUTHOR_EMAIL, GIT_AUTHOR_DATE, GIT_COMMITTER_NAME, GIT_COMMITTER_EMAIL,\r
and GIT_COMMITTER_DATE are set according to the current commit.  The values\r
of these variables after the filters have run, are used for the new commit.\r
If any evaluation of &lt;command&gt; returns a non-zero exit status, the whole\r
operation will be aborted.</simpara>\r
<simpara>A <emphasis>map</emphasis> function is available that takes an "original sha1 id" argument\r
and outputs a "rewritten sha1 id" if the commit has been already\r
rewritten, and "original sha1 id" otherwise; the <emphasis>map</emphasis> function can\r
return several ids on separate lines if your commit filter emitted\r
multiple commits.</simpara>\r
</section>\r
</simplesect>\r
<simplesect id="_options">\r
<title>OPTIONS</title>\r
<variablelist>\r
<varlistentry>\r
<term>\r
--env-filter &lt;command&gt;\r
</term>\r
<listitem>\r
<simpara>\r
        This filter may be used if you only need to modify the environment\r
        in which the commit will be performed.  Specifically, you might\r
        want to rewrite the author/committer name/email/time environment\r
        variables (see <xref linkend="git-commit-tree(1)" /> for details).  Do not forget\r
        to re-export the variables.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
--tree-filter &lt;command&gt;\r
</term>\r
<listitem>\r
<simpara>\r
        This is the filter for rewriting the tree and its contents.\r
        The argument is evaluated in shell with the working\r
        directory set to the root of the checked out tree.  The new tree\r
        is then used as-is (new files are auto-added, disappeared files\r
        are auto-removed - neither .gitignore files nor any other ignore\r
        rules <emphasis role="strong">HAVE ANY EFFECT</emphasis>!).\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
--index-filter &lt;command&gt;\r
</term>\r
<listitem>\r
<simpara>\r
        This is the filter for rewriting the index.  It is similar to the\r
        tree filter but does not check out the tree, which makes it much\r
        faster.  Frequently used with <emphasis>git rm --cached\r
        --ignore-unmatch ...</emphasis>, see EXAMPLES below.  For hairy\r
        cases, see <xref linkend="git-update-index(1)" />.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
--parent-filter &lt;command&gt;\r
</term>\r
<listitem>\r
<simpara>\r
        This is the filter for rewriting the commit's parent list.\r
        It will receive the parent string on stdin and shall output\r
        the new parent string on stdout.  The parent string is in\r
        the format described in <xref linkend="git-commit-tree(1)" />: empty for\r
        the initial commit, "-p parent" for a normal commit and\r
        "-p parent1 -p parent2 -p parent3 &#8230;" for a merge commit.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
--msg-filter &lt;command&gt;\r
</term>\r
<listitem>\r
<simpara>\r
        This is the filter for rewriting the commit messages.\r
        The argument is evaluated in the shell with the original\r
        commit message on standard input; its standard output is\r
        used as the new commit message.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
--commit-filter &lt;command&gt;\r
</term>\r
<listitem>\r
<simpara>\r
        This is the filter for performing the commit.\r
        If this filter is specified, it will be called instead of the\r
        <emphasis>git commit-tree</emphasis> command, with arguments of the form\r
        "&lt;TREE_ID&gt; [(-p &lt;PARENT_COMMIT_ID&gt;)&#8230;]" and the log message on\r
        stdin.  The commit id is expected on stdout.\r
</simpara>\r
<simpara>As a special extension, the commit filter may emit multiple\r
commit ids; in that case, the rewritten children of the original commit will\r
have all of them as parents.</simpara>\r
<simpara>You can use the <emphasis>map</emphasis> convenience function in this filter, and other\r
convenience functions, too.  For example, calling <emphasis>skip_commit "$@"</emphasis>\r
will leave out the current commit (but not its changes! If you want\r
that, use <emphasis>git rebase</emphasis> instead).</simpara>\r
<simpara>You can also use the <emphasis>git_commit_non_empty_tree "$@"</emphasis> instead of\r
<emphasis>git commit-tree "$@"</emphasis> if you don't wish to keep commits with a single parent\r
and that makes no change to the tree.</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
--tag-name-filter &lt;command&gt;\r
</term>\r
<listitem>\r
<simpara>\r
        This is the filter for rewriting tag names. When passed,\r
        it will be called for every tag ref that points to a rewritten\r
        object (or to a tag object which points to a rewritten object).\r
        The original tag name is passed via standard input, and the new\r
        tag name is expected on standard output.\r
</simpara>\r
<simpara>The original tags are not deleted, but can be overwritten;\r
use "--tag-name-filter cat" to simply update the tags.  In this\r
case, be very careful and make sure you have the old tags\r
backed up in case the conversion has run afoul.</simpara>\r
<simpara>Nearly proper rewriting of tag objects is supported. If the tag has\r
a message attached, a new tag object will be created with the same message,\r
author, and timestamp. If the tag has a signature attached, the\r
signature will be stripped. It is by definition impossible to preserve\r
signatures. The reason this is "nearly" proper, is because ideally if\r
the tag did not change (points to the same object, has the same name, etc.)\r
it should retain any signature. That is not the case, signatures will always\r
be removed, buyer beware. There is also no support for changing the\r
author or timestamp (or the tag message for that matter). Tags which point\r
to other tags will be rewritten to point to the underlying commit.</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
--subdirectory-filter &lt;directory&gt;\r
</term>\r
<listitem>\r
<simpara>\r
        Only look at the history which touches the given subdirectory.\r
        The result will contain that directory (and only that) as its\r
        project root. Implies <xref linkend="Remap_to_ancestor"/>.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
--prune-empty\r
</term>\r
<listitem>\r
<simpara>\r
        Some kind of filters will generate empty commits, that left the tree\r
        untouched.  This switch allow git-filter-branch to ignore such\r
        commits.  Though, this switch only applies for commits that have one\r
        and only one parent, it will hence keep merges points. Also, this\r
        option is not compatible with the use of <emphasis>--commit-filter</emphasis>. Though you\r
        just need to use the function <emphasis>git_commit_non_empty_tree "$@"</emphasis> instead\r
        of the <emphasis>git commit-tree "$@"</emphasis> idiom in your commit filter to make that\r
        happen.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
--original &lt;namespace&gt;\r
</term>\r
<listitem>\r
<simpara>\r
        Use this option to set the namespace where the original commits\r
        will be stored. The default value is <emphasis>refs/original</emphasis>.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
-d &lt;directory&gt;\r
</term>\r
<listitem>\r
<simpara>\r
        Use this option to set the path to the temporary directory used for\r
        rewriting.  When applying a tree filter, the command needs to\r
        temporarily check out the tree to some directory, which may consume\r
        considerable space in case of large projects.  By default it\r
        does this in the <emphasis>.git-rewrite/</emphasis> directory but you can override\r
        that choice by this parameter.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
-f\r
</term>\r
<term>\r
--force\r
</term>\r
<listitem>\r
<simpara>\r
        <emphasis>git filter-branch</emphasis> refuses to start with an existing temporary\r
        directory or when there are already refs starting with\r
        <emphasis>refs/original/</emphasis>, unless forced.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
<varlistentry>\r
<term>\r
&lt;rev-list options&gt;&#8230;\r
</term>\r
<listitem>\r
<simpara>\r
        Arguments for <emphasis>git rev-list</emphasis>.  All positive refs included by\r
        these options are rewritten.  You may also specify options\r
        such as <emphasis>--all</emphasis>, but you must use <emphasis>--</emphasis> to separate them from\r
        the <emphasis>git filter-branch</emphasis> options. Implies <xref linkend="Remap_to_ancestor"/>.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
</variablelist>\r
<section id="Remap_to_ancestor">\r
<title>Remap to ancestor</title>\r
<simpara>By using <xref linkend="rev-list(1)" /> arguments, e.g., path limiters, you can limit the\r
set of revisions which get rewritten. However, positive refs on the command\r
line are distinguished: we don't let them be excluded by such limiters. For\r
this purpose, they are instead rewritten to point at the nearest ancestor that\r
was not excluded.</simpara>\r
</section>\r
</simplesect>\r
<simplesect id="_examples">\r
<title>Examples</title>\r
<simpara>Suppose you want to remove a file (containing confidential information\r
or copyright violation) from all commits:</simpara>\r
<screen>git filter-branch --tree-filter 'rm filename' HEAD</screen>\r
<simpara>However, if the file is absent from the tree of some commit,\r
a simple <emphasis>rm filename</emphasis> will fail for that tree and commit.\r
Thus you may instead want to use <emphasis>rm -f filename</emphasis> as the script.</simpara>\r
<simpara>Using <emphasis>--index-filter</emphasis> with <emphasis>git rm</emphasis> yields a significantly faster\r
version.  Like with using <emphasis>rm filename</emphasis>, <emphasis>git rm --cached filename</emphasis>\r
will fail if the file is absent from the tree of a commit.  If you\r
want to "completely forget" a file, it does not matter when it entered\r
history, so we also add <emphasis>--ignore-unmatch</emphasis>:</simpara>\r
<screen>git filter-branch --index-filter 'git rm --cached --ignore-unmatch filename' HEAD</screen>\r
<simpara>Now, you will get the rewritten history saved in HEAD.</simpara>\r
<simpara>To rewrite the repository to look as if <emphasis>foodir/</emphasis> had been its project\r
root, and discard all other history:</simpara>\r
<screen>git filter-branch --subdirectory-filter foodir -- --all</screen>\r
<simpara>Thus you can, e.g., turn a library subdirectory into a repository of\r
its own.  Note the <emphasis>--</emphasis> that separates <emphasis>filter-branch</emphasis> options from\r
revision options, and the <emphasis>--all</emphasis> to rewrite all branches and tags.</simpara>\r
<simpara>To set a commit (which typically is at the tip of another\r
history) to be the parent of the current initial commit, in\r
order to paste the other history behind the current history:</simpara>\r
<screen>git filter-branch --parent-filter 'sed "s/^\$/-p &lt;graft-id&gt;/"' HEAD</screen>\r
<simpara>(if the parent string is empty - which happens when we are dealing with\r
the initial commit - add graftcommit as a parent).  Note that this assumes\r
history with a single root (that is, no merge without common ancestors\r
happened).  If this is not the case, use:</simpara>\r
<screen>git filter-branch --parent-filter \\r
        'test $GIT_COMMIT = &lt;commit-id&gt; &amp;&amp; echo "-p &lt;graft-id&gt;" || cat' HEAD</screen>\r
<simpara>or even simpler:</simpara>\r
<screen>echo "$commit-id $graft-id" &gt;&gt; .git/info/grafts\r
git filter-branch $graft-id..HEAD</screen>\r
<simpara>To remove commits authored by "Darl McBribe" from the history:</simpara>\r
<screen>git filter-branch --commit-filter '\r
        if [ "$GIT_AUTHOR_NAME" = "Darl McBribe" ];\r
        then\r
                skip_commit "$@";\r
        else\r
                git commit-tree "$@";\r
        fi' HEAD</screen>\r
<simpara>The function <emphasis>skip_commit</emphasis> is defined as follows:</simpara>\r
<screen>skip_commit()\r
{\r
        shift;\r
        while [ -n "$1" ];\r
        do\r
                shift;\r
                map "$1";\r
                shift;\r
        done;\r
}</screen>\r
<simpara>The shift magic first throws away the tree id and then the -p\r
parameters.  Note that this handles merges properly! In case Darl\r
committed a merge between P1 and P2, it will be propagated properly\r
and all children of the merge will become merge commits with P1,P2\r
as their parents instead of the merge commit.</simpara>\r
<simpara>You can rewrite the commit log messages using <emphasis>--msg-filter</emphasis>.  For\r
example, <emphasis>git svn-id</emphasis> strings in a repository created by <emphasis>git svn</emphasis> can\r
be removed this way:</simpara>\r
<screen>git filter-branch --msg-filter '\r
        sed -e "/^git-svn-id:/d"\r
'</screen>\r
<simpara>To restrict rewriting to only part of the history, specify a revision\r
range in addition to the new branch name.  The new branch name will\r
point to the top-most revision that a <emphasis>git rev-list</emphasis> of this range\r
will print.</simpara>\r
<simpara>If you need to add <emphasis>Acked-by</emphasis> lines to, say, the last 10 commits (none\r
of which is a merge), use this command:</simpara>\r
<screen>git filter-branch --msg-filter '\r
        cat &amp;&amp;\r
        echo "Acked-by: Bugs Bunny &lt;bunny@bugzilla.org&gt;"\r
' HEAD~10..HEAD</screen>\r
<simpara><emphasis role="strong">NOTE</emphasis> the changes introduced by the commits, and which are not reverted\r
by subsequent commits, will still be in the rewritten branch. If you want\r
to throw out <emphasis>changes</emphasis> together with the commits, you should use the\r
interactive mode of <emphasis>git rebase</emphasis>.</simpara>\r
<simpara>Consider this history:</simpara>\r
<screen>     D--E--F--G--H\r
    /     /\r
A--B-----C</screen>\r
<simpara>To rewrite only commits D,E,F,G,H, but leave A, B and C alone, use:</simpara>\r
<screen>git filter-branch ... C..H</screen>\r
<simpara>To rewrite commits E,F,G,H, use one of these:</simpara>\r
<screen>git filter-branch ... C..H --not D\r
git filter-branch ... D..H --not C</screen>\r
<simpara>To move the whole tree into a subdirectory, or remove it from there:</simpara>\r
<screen>git filter-branch --index-filter \\r
        'git ls-files -s | sed "s-\t\"*-&amp;newsubdir/-" |\r
                GIT_INDEX_FILE=$GIT_INDEX_FILE.new \\r
                        git update-index --index-info &amp;&amp;\r
         mv "$GIT_INDEX_FILE.new" "$GIT_INDEX_FILE"' HEAD</screen>\r
</simplesect>\r
<simplesect id="_checklist_for_shrinking_a_repository">\r
<title>Checklist for Shrinking a Repository</title>\r
<simpara>git-filter-branch is often used to get rid of a subset of files,\r
usually with some combination of <emphasis>--index-filter</emphasis> and\r
<emphasis>--subdirectory-filter</emphasis>.  People expect the resulting repository to\r
be smaller than the original, but you need a few more steps to\r
actually make it smaller, because git tries hard not to lose your\r
objects until you tell it to.  First make sure that:</simpara>\r
<itemizedlist>\r
<listitem>\r
<simpara>\r
You really removed all variants of a filename, if a blob was moved\r
  over its lifetime.  <emphasis>git log --name-only --follow --all -- filename</emphasis>\r
  can help you find renames.\r
</simpara>\r
</listitem>\r
<listitem>\r
<simpara>\r
You really filtered all refs: use <emphasis>--tag-name-filter cat -- --all</emphasis>\r
  when calling git-filter-branch.\r
</simpara>\r
</listitem>\r
</itemizedlist>\r
<simpara>Then there are two ways to get a smaller repository.  A safer way is\r
to clone, that keeps your original intact.</simpara>\r
<itemizedlist>\r
<listitem>\r
<simpara>\r
Clone it with <emphasis>git clone file:///path/to/repo</emphasis>.  The clone\r
  will not have the removed objects.  See <xref linkend="git-clone(1)" />.  (Note\r
  that cloning with a plain path just hardlinks everything!)\r
</simpara>\r
</listitem>\r
</itemizedlist>\r
<simpara>If you really don't want to clone it, for whatever reasons, check the\r
following points instead (in this order).  This is a very destructive\r
approach, so <emphasis role="strong">make a backup</emphasis> or go back to cloning it.  You have been\r
warned.</simpara>\r
<itemizedlist>\r
<listitem>\r
<simpara>\r
Remove the original refs backed up by git-filter-branch: say <emphasis>git\r
  for-each-ref --format="%(refname)" refs/original/ | xargs -n 1 git\r
  update-ref -d</emphasis>.\r
</simpara>\r
</listitem>\r
<listitem>\r
<simpara>\r
Expire all reflogs with <emphasis>git reflog expire --expire=now --all</emphasis>.\r
</simpara>\r
</listitem>\r
<listitem>\r
<simpara>\r
Garbage collect all unreferenced objects with <emphasis>git gc --prune=now</emphasis>\r
  (or if your git-gc is not new enough to support arguments to\r
  <emphasis>--prune</emphasis>, use <emphasis>git repack -ad; git prune</emphasis> instead).\r
</simpara>\r
</listitem>\r
</itemizedlist>\r
</simplesect>\r
<simplesect id="_git">\r
<title>GIT</title>\r
<simpara>Part of the <xref linkend="git(1)" /> suite</simpara>\r
</simplesect>\r
</article>\r