| blob | 8ae859e027d0e249e5229cbbdc8fdfd37acd1ae9 |
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 }
129 }
133 }
135 /* Block element titles. */
143 }
146 }
150 }
153 }
156 }
162 }
168 }
176 }
181 }
185 }
189 }
190 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
193 }
202 }
206 }
211 }
217 dl {
220 }
221 dt {
226 }
229 }
233 }
236 }
239 }
242 }
245 }
248 }
255 }
259 }
263 }
264 tfoot {
266 }
269 }
272 }
273 /* Because the table frame attribute is overriden by CSS in most browsers. */
276 }
280 }
284 }
290 }
293 }
296 }
302 }
305 }
309 }
313 }
317 }
321 }
326 }
330 }
340 }
345 }
347 div#toc {
349 }
351 div#toctitle {
358 }
363 }
367 }
371 }
375 }
376 /* Overrides for manpage documents */
377 h1 {
382 }
383 h2 {
385 }
388 }
392 }
394 /* Workarounds for IE6's broken and incomplete CSS2. */
400 }
407 }
413 }
418 }
422 }
426 }
431 }
433 /* IE6 sets dynamically generated links as visited. */
435 </style>
437 /*<![CDATA[*/
441 /////////////////////////////////////////////////////////////////////
442 // Table Of Contents generator
443 /////////////////////////////////////////////////////////////////////
445 /* Author: Mihai Bazon, September 2002
446 * http://students.infoiasi.ro/~mishoo
447 *
448 * Table Of Content generator
449 * Version: 0.4
450 *
451 * Feel free to use this script under the terms of the GNU General Public
452 * License, as long as you do not remove or alter this notice.
453 */
455 /* modified by Troy D. Hanson, September 2006. License: GPL */
456 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
458 // toclevels = 1..4.
468 }
470 }
476 }
481 // Function that scans the DOM tree for header elements (the DOM2
482 // nodeIterator API would be a better technique but not supported by all
483 // browsers).
490 }
492 }
493 }
494 }
497 }
512 }
515 },
518 /////////////////////////////////////////////////////////////////////
519 // Footnotes generator
520 /////////////////////////////////////////////////////////////////////
522 /* Based on footnote generation code from:
523 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
524 */
534 n++;
535 // Use [\s\S] in place of . so multi-line matches work.
536 // Because JavaScript has no s (dotall) regex flag.
547 }
548 }
552 // Process footnoterefs.
561 }
562 }
563 }
564 }
566 }
567 /*]]>*/
568 </script>
569 </head>
570 <body>
572 <h1>
573 git-filter-branch(1) Manual Page
574 </h1>
577 <p>git-filter-branch -
578 Rewrite branches
579 </p>
580 </div>
581 </div>
586 <div class="verseblock-content"><em>git filter-branch</em> [--env-filter <command>] [--tree-filter <command>]
590 [--prune-empty]
594 </div></div>
595 </div>
598 <div class="paragraph"><p>Lets you rewrite git revision history by rewriting the branches mentioned
600 Those filters can modify each tree (e.g. removing a file or running
601 a perl rewrite on all files) or information about each commit.
602 Otherwise, all information (including original commit times or merge
603 information) will be preserved.</p></div>
604 <div class="paragraph"><p>The command will only rewrite the <em>positive</em> refs mentioned in the
606 If you specify no filters, the commits will be recommitted without any
607 changes, which would normally have no effect. Nevertheless, this may be
608 useful in the future for compensating for some git bugs or such,
609 therefore such a usage is permitted.</p></div>
610 <div class="paragraph"><p><strong>NOTE</strong>: This command honors <tt>.git/info/grafts</tt> and <tt>.git/refs/replace/</tt>.
611 If you have any grafts or replacement refs defined, running this command
612 will make them permanent.</p></div>
613 <div class="paragraph"><p><strong>WARNING</strong>! The rewritten history will have different object names for all
614 the objects and will not converge with the original branch. You will not
615 be able to easily push and distribute the rewritten branch on top of the
616 original branch. Please do not use this command if you do not know the
617 full implications, and avoid using it anyway, if a simple single commit
618 would suffice to fix your problem. (See the "RECOVERING FROM UPSTREAM
620 rewriting published history.)</p></div>
621 <div class="paragraph"><p>Always verify that the rewritten version is correct: The original refs,
622 if different from the rewritten ones, will be stored in the namespace
625 be a good idea to redirect the temporary directory off-disk with the
628 <div class="paragraph"><p>The filters are applied in the order as listed below. The <command>
630 (with the notable exception of the commit filter, for technical reasons).
631 Prior to that, the $GIT_COMMIT environment variable will be set to contain
632 the id of the commit being rewritten. Also, GIT_AUTHOR_NAME,
633 GIT_AUTHOR_EMAIL, GIT_AUTHOR_DATE, GIT_COMMITTER_NAME, GIT_COMMITTER_EMAIL,
634 and GIT_COMMITTER_DATE are set according to the current commit. The values
635 of these variables after the filters have run, are used for the new commit.
637 operation will be aborted.</p></div>
638 <div class="paragraph"><p>A <em>map</em> function is available that takes an "original sha1 id" argument
639 and outputs a "rewritten sha1 id" if the commit has been already
641 return several ids on separate lines if your commit filter emitted
642 multiple commits.</p></div>
643 </div>
649 </dt>
650 <dd>
651 <p>
652 This filter may be used if you only need to modify the environment
653 in which the commit will be performed. Specifically, you might
654 want to rewrite the author/committer name/email/time environment
655 variables (see <a href="git-commit-tree.html">git-commit-tree(1)</a> for details). Do not forget
656 to re-export the variables.
657 </p>
658 </dd>
661 </dt>
662 <dd>
663 <p>
664 This is the filter for rewriting the tree and its contents.
665 The argument is evaluated in shell with the working
666 directory set to the root of the checked out tree. The new tree
667 is then used as-is (new files are auto-added, disappeared files
668 are auto-removed - neither .gitignore files nor any other ignore
670 </p>
671 </dd>
674 </dt>
675 <dd>
676 <p>
677 This is the filter for rewriting the index. It is similar to the
678 tree filter but does not check out the tree, which makes it much
679 faster. Frequently used with <tt>git rm --cached
682 </p>
683 </dd>
686 </dt>
687 <dd>
688 <p>
689 This is the filter for rewriting the commit’s parent list.
690 It will receive the parent string on stdin and shall output
691 the new parent string on stdout. The parent string is in
693 the initial commit, "-p parent" for a normal commit and
694 "-p parent1 -p parent2 -p parent3 …" for a merge commit.
695 </p>
696 </dd>
699 </dt>
700 <dd>
701 <p>
702 This is the filter for rewriting the commit messages.
703 The argument is evaluated in the shell with the original
704 commit message on standard input; its standard output is
705 used as the new commit message.
706 </p>
707 </dd>
710 </dt>
711 <dd>
712 <p>
713 This is the filter for performing the commit.
714 If this filter is specified, it will be called instead of the
716 "<TREE_ID> [(-p <PARENT_COMMIT_ID>)…]" and the log message on
717 stdin. The commit id is expected on stdout.
718 </p>
720 commit ids; in that case, the rewritten children of the original commit will
721 have all of them as parents.</p></div>
722 <div class="paragraph"><p>You can use the <em>map</em> convenience function in this filter, and other
724 will leave out the current commit (but not its changes! If you want
726 <div class="paragraph"><p>You can also use the <tt>git_commit_non_empty_tree "$@"</tt> instead of
728 and that makes no change to the tree.</p></div>
729 </dd>
732 </dt>
733 <dd>
734 <p>
735 This is the filter for rewriting tag names. When passed,
736 it will be called for every tag ref that points to a rewritten
737 object (or to a tag object which points to a rewritten object).
738 The original tag name is passed via standard input, and the new
739 tag name is expected on standard output.
740 </p>
742 use "--tag-name-filter cat" to simply update the tags. In this
743 case, be very careful and make sure you have the old tags
744 backed up in case the conversion has run afoul.</p></div>
746 a message attached, a new tag object will be created with the same message,
747 author, and timestamp. If the tag has a signature attached, the
748 signature will be stripped. It is by definition impossible to preserve
749 signatures. The reason this is "nearly" proper, is because ideally if
750 the tag did not change (points to the same object, has the same name, etc.)
751 it should retain any signature. That is not the case, signatures will always
752 be removed, buyer beware. There is also no support for changing the
753 author or timestamp (or the tag message for that matter). Tags which point
754 to other tags will be rewritten to point to the underlying commit.</p></div>
755 </dd>
758 </dt>
759 <dd>
760 <p>
761 Only look at the history which touches the given subdirectory.
762 The result will contain that directory (and only that) as its
764 </p>
765 </dd>
767 --prune-empty
768 </dt>
769 <dd>
770 <p>
771 Some kind of filters will generate empty commits, that left the tree
772 untouched. This switch allow git-filter-branch to ignore such
773 commits. Though, this switch only applies for commits that have one
774 and only one parent, it will hence keep merges points. Also, this
778 happen.
779 </p>
780 </dd>
783 </dt>
784 <dd>
785 <p>
786 Use this option to set the namespace where the original commits
788 </p>
789 </dd>
792 </dt>
793 <dd>
794 <p>
795 Use this option to set the path to the temporary directory used for
796 rewriting. When applying a tree filter, the command needs to
797 temporarily check out the tree to some directory, which may consume
798 considerable space in case of large projects. By default it
800 that choice by this parameter.
801 </p>
802 </dd>
804 -f
805 </dt>
807 --force
808 </dt>
809 <dd>
810 <p>
812 directory or when there are already refs starting with
814 </p>
815 </dd>
818 </dt>
819 <dd>
820 <p>
822 these options are rewritten. You may also specify options
824 the <em>git filter-branch</em> options. Implies <a href="#Remap_to_ancestor">[Remap_to_ancestor]</a>.
825 </p>
826 </dd>
827 </dl></div>
829 <div class="paragraph"><p>By using <a href="rev-list.html">rev-list(1)</a> arguments, e.g., path limiters, you can limit the
830 set of revisions which get rewritten. However, positive refs on the command
831 line are distinguished: we don’t let them be excluded by such limiters. For
832 this purpose, they are instead rewritten to point at the nearest ancestor that
833 was not excluded.</p></div>
834 </div>
837 <div class="paragraph"><p>Suppose you want to remove a file (containing confidential information
838 or copyright violation) from all commits:</p></div>
842 </div></div>
846 <div class="paragraph"><p>Using <tt>--index-filter</tt> with <em>git rm</em> yields a significantly faster
848 will fail if the file is absent from the tree of a commit. If you
849 want to "completely forget" a file, it does not matter when it entered
853 <pre><tt>git filter-branch --index-filter 'git rm --cached --ignore-unmatch filename' HEAD</tt></pre>
854 </div></div>
856 <div class="paragraph"><p>To rewrite the repository to look as if <tt>foodir/</tt> had been its project
857 root, and discard all other history:</p></div>
861 </div></div>
866 history) to be the parent of the current initial commit, in
867 order to paste the other history behind the current history:</p></div>
871 </div></div>
872 <div class="paragraph"><p>(if the parent string is empty - which happens when we are dealing with
873 the initial commit - add graftcommit as a parent). Note that this assumes
874 history with a single root (that is, no merge without common ancestors
875 happened). If this is not the case, use:</p></div>
878 <pre><tt>git filter-branch --parent-filter \
879 'test $GIT_COMMIT = <commit-id> && echo "-p <graft-id>" || cat' HEAD</tt></pre>
880 </div></div>
885 git filter-branch $graft-id..HEAD</tt></pre>
886 </div></div>
887 <div class="paragraph"><p>To remove commits authored by "Darl McBribe" from the history:</p></div>
890 <pre><tt>git filter-branch --commit-filter '
892 then
893 skip_commit "$@";
894 else
895 git commit-tree "$@";
896 fi' HEAD</tt></pre>
897 </div></div>
901 <pre><tt>skip_commit()
902 {
903 shift;
904 while [ -n "$1" ];
905 do
906 shift;
907 map "$1";
908 shift;
909 done;
910 }</tt></pre>
911 </div></div>
913 parameters. Note that this handles merges properly! In case Darl
914 committed a merge between P1 and P2, it will be propagated properly
915 and all children of the merge will become merge commits with P1,P2
916 as their parents instead of the merge commit.</p></div>
917 <div class="paragraph"><p>You can rewrite the commit log messages using <tt>--msg-filter</tt>. For
919 be removed this way:</p></div>
922 <pre><tt>git filter-branch --msg-filter '
923 sed -e "/^git-svn-id:/d"
924 '</tt></pre>
925 </div></div>
927 range in addition to the new branch name. The new branch name will
929 will print.</p></div>
930 <div class="paragraph"><p>If you need to add <em>Acked-by</em> lines to, say, the last 10 commits (none
931 of which is a merge), use this command:</p></div>
934 <pre><tt>git filter-branch --msg-filter '
935 cat &&
936 echo "Acked-by: Bugs Bunny <bunny@bugzilla.org>"
938 </div></div>
939 <div class="paragraph"><p><strong>NOTE</strong> the changes introduced by the commits, and which are not reverted
940 by subsequent commits, will still be in the rewritten branch. If you want
946 <pre><tt> D--E--F--G--H
947 / /
948 A--B-----C</tt></pre>
949 </div></div>
950 <div class="paragraph"><p>To rewrite only commits D,E,F,G,H, but leave A, B and C alone, use:</p></div>
954 </div></div>
958 <pre><tt>git filter-branch ... C..H --not D
959 git filter-branch ... D..H --not C</tt></pre>
960 </div></div>
961 <div class="paragraph"><p>To move the whole tree into a subdirectory, or remove it from there:</p></div>
964 <pre><tt>git filter-branch --index-filter \
966 GIT_INDEX_FILE=$GIT_INDEX_FILE.new \
967 git update-index --index-info &&
969 </div></div>
970 </div>
974 usually with some combination of <tt>--index-filter</tt> and
975 <tt>--subdirectory-filter</tt>. People expect the resulting repository to
976 be smaller than the original, but you need a few more steps to
977 actually make it smaller, because git tries hard not to lose your
978 objects until you tell it to. First make sure that:</p></div>
980 <li>
981 <p>
982 You really removed all variants of a filename, if a blob was moved
983 over its lifetime. <tt>git log --name-only --follow --all --
984 filename</tt> can help you find renames.
985 </p>
986 </li>
987 <li>
988 <p>
989 You really filtered all refs: use <tt>--tag-name-filter cat --
990 --all</tt> when calling git-filter-branch.
991 </p>
992 </li>
993 </ul></div>
995 to clone, that keeps your original intact.</p></div>
997 <li>
998 <p>
999 Clone it with <tt>git clone file:///path/to/repo</tt>. The clone
1001 that cloning with a plain path just hardlinks everything!)
1002 </p>
1003 </li>
1004 </ul></div>
1005 <div class="paragraph"><p>If you really don’t want to clone it, for whatever reasons, check the
1006 following points instead (in this order). This is a very destructive
1007 approach, so <strong>make a backup</strong> or go back to cloning it. You have been
1008 warned.</p></div>
1010 <li>
1011 <p>
1012 Remove the original refs backed up by git-filter-branch: say <tt>git
1014 update-ref -d</tt>.
1015 </p>
1016 </li>
1017 <li>
1018 <p>
1019 Expire all reflogs with <tt>git reflog expire --expire=now --all</tt>.
1020 </p>
1021 </li>
1022 <li>
1023 <p>
1024 Garbage collect all unreferenced objects with <tt>git gc --prune=now</tt>
1025 (or if your git-gc is not new enough to support arguments to
1026 <tt>--prune</tt>, use <tt>git repack -ad; git prune</tt> instead).
1027 </p>
1028 </li>
1029 </ul></div>
1030 </div>
1034 </div>
1035 </div>
1039 Last updated 2011-09-21 23:01:14 PDT
1040 </div>
1041 </div>
1042 </body>
1043 </html>