| blob | 4afadbdde4a6d7bb71fb4d92d49f050e65e3b9e4 |
4 <head>
9 /* Debug borders */
11 /*
12 border: 1px solid red;
13 */
14 }
16 body {
18 }
20 a {
23 }
26 }
28 em {
31 }
33 strong {
36 }
38 tt {
40 }
48 }
52 }
53 h2 {
55 }
56 h3 {
58 }
59 h3 + * {
61 }
66 }
68 hr {
70 }
72 p {
75 }
79 }
81 pre {
84 }
86 span#author {
91 }
92 span#email {
93 }
96 }
98 div#footer {
104 }
105 div#footer-text {
108 }
109 div#footer-badges {
112 }
114 div#preamble {
117 }
123 }
127 }
131 }
133 /* Block element titles. */
141 }
144 }
148 }
151 }
154 }
160 }
166 }
171 }
175 }
180 }
183 }
187 }
188 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
191 }
200 }
204 }
209 }
215 dl {
218 }
219 dt {
224 }
227 }
231 }
234 }
237 }
240 }
243 }
246 }
253 }
257 }
258 thead {
261 }
262 tfoot {
264 }
267 }
270 }
271 /* Because the table frame attribute is overriden by CSS in most browsers. */
274 }
278 }
282 }
288 }
291 }
294 }
300 }
303 }
307 }
311 }
315 }
317 div#toctitle {
324 }
329 }
333 }
337 }
341 }
342 /* Overrides for manpage documents */
343 h1 {
348 }
349 h2 {
351 }
354 }
358 }
360 /* Workarounds for IE6's broken and incomplete CSS2. */
366 }
373 }
379 }
384 }
388 }
392 }
397 }
399 /* IE6 sets dynamically generated links as visited. */
401 </style>
402 </head>
403 <body>
405 <h1>
406 git-filter-branch(1) Manual Page
407 </h1>
410 <p>git-filter-branch -
411 Rewrite branches
412 </p>
413 </div>
414 </div>
418 <div class="verseblock-content"><em>git filter-branch</em> [--env-filter <command>] [--tree-filter <command>]
422 [--prune-empty]
426 </div></div>
427 </div>
430 <div class="paragraph"><p>Lets you rewrite git revision history by rewriting the branches mentioned
432 Those filters can modify each tree (e.g. removing a file or running
433 a perl rewrite on all files) or information about each commit.
434 Otherwise, all information (including original commit times or merge
435 information) will be preserved.</p></div>
436 <div class="paragraph"><p>The command will only rewrite the <em>positive</em> refs mentioned in the
438 If you specify no filters, the commits will be recommitted without any
439 changes, which would normally have no effect. Nevertheless, this may be
440 useful in the future for compensating for some git bugs or such,
441 therefore such a usage is permitted.</p></div>
442 <div class="paragraph"><p><strong>NOTE</strong>: This command honors <tt>.git/info/grafts</tt> and <tt>.git/refs/replace/</tt>.
443 If you have any grafts or replacement refs defined, running this command
444 will make them permanent.</p></div>
445 <div class="paragraph"><p><strong>WARNING</strong>! The rewritten history will have different object names for all
446 the objects and will not converge with the original branch. You will not
447 be able to easily push and distribute the rewritten branch on top of the
448 original branch. Please do not use this command if you do not know the
449 full implications, and avoid using it anyway, if a simple single commit
450 would suffice to fix your problem. (See the "RECOVERING FROM UPSTREAM
452 rewriting published history.)</p></div>
453 <div class="paragraph"><p>Always verify that the rewritten version is correct: The original refs,
454 if different from the rewritten ones, will be stored in the namespace
457 be a good idea to redirect the temporary directory off-disk with the
460 <div class="paragraph"><p>The filters are applied in the order as listed below. The <command>
462 (with the notable exception of the commit filter, for technical reasons).
463 Prior to that, the $GIT_COMMIT environment variable will be set to contain
464 the id of the commit being rewritten. Also, GIT_AUTHOR_NAME,
465 GIT_AUTHOR_EMAIL, GIT_AUTHOR_DATE, GIT_COMMITTER_NAME, GIT_COMMITTER_EMAIL,
466 and GIT_COMMITTER_DATE are set according to the current commit. The values
467 of these variables after the filters have run, are used for the new commit.
469 operation will be aborted.</p></div>
470 <div class="paragraph"><p>A <em>map</em> function is available that takes an "original sha1 id" argument
471 and outputs a "rewritten sha1 id" if the commit has been already
473 return several ids on separate lines if your commit filter emitted
474 multiple commits.</p></div>
475 </div>
481 </dt>
482 <dd>
483 <p>
484 This filter may be used if you only need to modify the environment
485 in which the commit will be performed. Specifically, you might
486 want to rewrite the author/committer name/email/time environment
487 variables (see <a href="git-commit-tree.html">git-commit-tree(1)</a> for details). Do not forget
488 to re-export the variables.
489 </p>
490 </dd>
493 </dt>
494 <dd>
495 <p>
496 This is the filter for rewriting the tree and its contents.
497 The argument is evaluated in shell with the working
498 directory set to the root of the checked out tree. The new tree
499 is then used as-is (new files are auto-added, disappeared files
500 are auto-removed - neither .gitignore files nor any other ignore
502 </p>
503 </dd>
506 </dt>
507 <dd>
508 <p>
509 This is the filter for rewriting the index. It is similar to the
510 tree filter but does not check out the tree, which makes it much
511 faster. Frequently used with <tt>git rm --cached
514 </p>
515 </dd>
518 </dt>
519 <dd>
520 <p>
521 This is the filter for rewriting the commit’s parent list.
522 It will receive the parent string on stdin and shall output
523 the new parent string on stdout. The parent string is in
525 the initial commit, "-p parent" for a normal commit and
526 "-p parent1 -p parent2 -p parent3 …" for a merge commit.
527 </p>
528 </dd>
531 </dt>
532 <dd>
533 <p>
534 This is the filter for rewriting the commit messages.
535 The argument is evaluated in the shell with the original
536 commit message on standard input; its standard output is
537 used as the new commit message.
538 </p>
539 </dd>
542 </dt>
543 <dd>
544 <p>
545 This is the filter for performing the commit.
546 If this filter is specified, it will be called instead of the
548 "<TREE_ID> [(-p <PARENT_COMMIT_ID>)…]" and the log message on
549 stdin. The commit id is expected on stdout.
550 </p>
552 commit ids; in that case, the rewritten children of the original commit will
553 have all of them as parents.</p></div>
554 <div class="paragraph"><p>You can use the <em>map</em> convenience function in this filter, and other
556 will leave out the current commit (but not its changes! If you want
558 <div class="paragraph"><p>You can also use the <tt>git_commit_non_empty_tree "$@"</tt> instead of
560 and that makes no change to the tree.</p></div>
561 </dd>
564 </dt>
565 <dd>
566 <p>
567 This is the filter for rewriting tag names. When passed,
568 it will be called for every tag ref that points to a rewritten
569 object (or to a tag object which points to a rewritten object).
570 The original tag name is passed via standard input, and the new
571 tag name is expected on standard output.
572 </p>
574 use "--tag-name-filter cat" to simply update the tags. In this
575 case, be very careful and make sure you have the old tags
576 backed up in case the conversion has run afoul.</p></div>
578 a message attached, a new tag object will be created with the same message,
579 author, and timestamp. If the tag has a signature attached, the
580 signature will be stripped. It is by definition impossible to preserve
581 signatures. The reason this is "nearly" proper, is because ideally if
582 the tag did not change (points to the same object, has the same name, etc.)
583 it should retain any signature. That is not the case, signatures will always
584 be removed, buyer beware. There is also no support for changing the
585 author or timestamp (or the tag message for that matter). Tags which point
586 to other tags will be rewritten to point to the underlying commit.</p></div>
587 </dd>
590 </dt>
591 <dd>
592 <p>
593 Only look at the history which touches the given subdirectory.
594 The result will contain that directory (and only that) as its
596 </p>
597 </dd>
599 --prune-empty
600 </dt>
601 <dd>
602 <p>
603 Some kind of filters will generate empty commits, that left the tree
604 untouched. This switch allow git-filter-branch to ignore such
605 commits. Though, this switch only applies for commits that have one
606 and only one parent, it will hence keep merges points. Also, this
610 happen.
611 </p>
612 </dd>
615 </dt>
616 <dd>
617 <p>
618 Use this option to set the namespace where the original commits
620 </p>
621 </dd>
624 </dt>
625 <dd>
626 <p>
627 Use this option to set the path to the temporary directory used for
628 rewriting. When applying a tree filter, the command needs to
629 temporarily check out the tree to some directory, which may consume
630 considerable space in case of large projects. By default it
632 that choice by this parameter.
633 </p>
634 </dd>
636 -f
637 </dt>
639 --force
640 </dt>
641 <dd>
642 <p>
644 directory or when there are already refs starting with
646 </p>
647 </dd>
650 </dt>
651 <dd>
652 <p>
654 these options are rewritten. You may also specify options
656 the <em>git filter-branch</em> options. Implies <a href="#Remap_to_ancestor">[Remap_to_ancestor]</a>.
657 </p>
658 </dd>
659 </dl></div>
661 <div class="paragraph"><p>By using <a href="rev-list.html">rev-list(1)</a> arguments, e.g., path limiters, you can limit the
662 set of revisions which get rewritten. However, positive refs on the command
663 line are distinguished: we don’t let them be excluded by such limiters. For
664 this purpose, they are instead rewritten to point at the nearest ancestor that
665 was not excluded.</p></div>
666 </div>
669 <div class="paragraph"><p>Suppose you want to remove a file (containing confidential information
670 or copyright violation) from all commits:</p></div>
674 </div></div>
678 <div class="paragraph"><p>Using <tt>--index-filter</tt> with <em>git rm</em> yields a significantly faster
680 will fail if the file is absent from the tree of a commit. If you
681 want to "completely forget" a file, it does not matter when it entered
685 <pre><tt>git filter-branch --index-filter 'git rm --cached --ignore-unmatch filename' HEAD</tt></pre>
686 </div></div>
688 <div class="paragraph"><p>To rewrite the repository to look as if <tt>foodir/</tt> had been its project
689 root, and discard all other history:</p></div>
693 </div></div>
698 history) to be the parent of the current initial commit, in
699 order to paste the other history behind the current history:</p></div>
703 </div></div>
704 <div class="paragraph"><p>(if the parent string is empty - which happens when we are dealing with
705 the initial commit - add graftcommit as a parent). Note that this assumes
706 history with a single root (that is, no merge without common ancestors
707 happened). If this is not the case, use:</p></div>
710 <pre><tt>git filter-branch --parent-filter \
711 'test $GIT_COMMIT = <commit-id> && echo "-p <graft-id>" || cat' HEAD</tt></pre>
712 </div></div>
717 git filter-branch $graft-id..HEAD</tt></pre>
718 </div></div>
719 <div class="paragraph"><p>To remove commits authored by "Darl McBribe" from the history:</p></div>
722 <pre><tt>git filter-branch --commit-filter '
724 then
725 skip_commit "$@";
726 else
727 git commit-tree "$@";
728 fi' HEAD</tt></pre>
729 </div></div>
733 <pre><tt>skip_commit()
734 {
735 shift;
736 while [ -n "$1" ];
737 do
738 shift;
739 map "$1";
740 shift;
741 done;
742 }</tt></pre>
743 </div></div>
745 parameters. Note that this handles merges properly! In case Darl
746 committed a merge between P1 and P2, it will be propagated properly
747 and all children of the merge will become merge commits with P1,P2
748 as their parents instead of the merge commit.</p></div>
749 <div class="paragraph"><p>You can rewrite the commit log messages using <tt>--msg-filter</tt>. For
751 be removed this way:</p></div>
754 <pre><tt>git filter-branch --msg-filter '
755 sed -e "/^git-svn-id:/d"
756 '</tt></pre>
757 </div></div>
759 range in addition to the new branch name. The new branch name will
761 will print.</p></div>
762 <div class="paragraph"><p>If you need to add <em>Acked-by</em> lines to, say, the last 10 commits (none
763 of which is a merge), use this command:</p></div>
766 <pre><tt>git filter-branch --msg-filter '
767 cat &&
768 echo "Acked-by: Bugs Bunny <bunny@bugzilla.org>"
770 </div></div>
771 <div class="paragraph"><p><strong>NOTE</strong> the changes introduced by the commits, and which are not reverted
772 by subsequent commits, will still be in the rewritten branch. If you want
778 <pre><tt> D--E--F--G--H
779 / /
780 A--B-----C</tt></pre>
781 </div></div>
782 <div class="paragraph"><p>To rewrite only commits D,E,F,G,H, but leave A, B and C alone, use:</p></div>
786 </div></div>
790 <pre><tt>git filter-branch ... C..H --not D
791 git filter-branch ... D..H --not C</tt></pre>
792 </div></div>
793 <div class="paragraph"><p>To move the whole tree into a subdirectory, or remove it from there:</p></div>
796 <pre><tt>git filter-branch --index-filter \
798 GIT_INDEX_FILE=$GIT_INDEX_FILE.new \
799 git update-index --index-info &&
801 </div></div>
802 </div>
806 usually with some combination of <tt>--index-filter</tt> and
807 <tt>--subdirectory-filter</tt>. People expect the resulting repository to
808 be smaller than the original, but you need a few more steps to
809 actually make it smaller, because git tries hard not to lose your
810 objects until you tell it to. First make sure that:</p></div>
812 <li>
813 <p>
814 You really removed all variants of a filename, if a blob was moved
815 over its lifetime. <tt>git log --name-only --follow --all --
816 filename</tt> can help you find renames.
817 </p>
818 </li>
819 <li>
820 <p>
821 You really filtered all refs: use <tt>--tag-name-filter cat --
822 --all</tt> when calling git-filter-branch.
823 </p>
824 </li>
825 </ul></div>
827 to clone, that keeps your original intact.</p></div>
829 <li>
830 <p>
831 Clone it with <tt>git clone file:///path/to/repo</tt>. The clone
833 that cloning with a plain path just hardlinks everything!)
834 </p>
835 </li>
836 </ul></div>
837 <div class="paragraph"><p>If you really don’t want to clone it, for whatever reasons, check the
838 following points instead (in this order). This is a very destructive
839 approach, so <strong>make a backup</strong> or go back to cloning it. You have been
840 warned.</p></div>
842 <li>
843 <p>
844 Remove the original refs backed up by git-filter-branch: say <tt>git
846 update-ref -d</tt>.
847 </p>
848 </li>
849 <li>
850 <p>
851 Expire all reflogs with <tt>git reflog expire --expire=now --all</tt>.
852 </p>
853 </li>
854 <li>
855 <p>
856 Garbage collect all unreferenced objects with <tt>git gc --prune=now</tt>
857 (or if your git-gc is not new enough to support arguments to
858 <tt>--prune</tt>, use <tt>git repack -ad; git prune</tt> instead).
859 </p>
860 </li>
861 </ul></div>
862 </div>
866 </div>
869 Last updated 2011-07-23 00:49:30 UTC
870 </div>
871 </div>
872 </body>
873 </html>