| blob | 7c00930100f429c084e1ad6f572f0d5826202fdf |
4 <head>
8 /* Debug borders */
10 /*
11 border: 1px solid red;
12 */
13 }
15 body {
17 }
19 a {
22 }
25 }
27 em {
29 }
31 strong {
33 }
35 tt {
37 }
45 }
49 }
50 h2 {
52 }
53 h3 {
55 }
56 h3 + * {
58 }
63 }
65 hr {
67 }
69 p {
72 }
74 pre {
77 }
79 span#author {
84 }
85 span#email {
86 }
87 span#revision {
89 }
91 div#footer {
97 }
98 div#footer-text {
101 }
102 div#footer-badges {
105 }
107 div#preamble,
114 }
118 }
122 }
124 /* Block element titles. */
131 }
134 }
138 }
141 }
144 }
150 }
154 }
159 }
163 }
167 }
170 }
179 }
183 }
188 }
192 }
198 dl {
201 }
202 dt {
206 }
209 }
213 }
216 }
220 }
221 thead {
224 }
225 tfoot {
227 }
232 }
235 }
240 }
243 }
247 }
249 div#toctitle {
256 }
261 }
265 }
269 }
273 }
275 /* Workarounds for IE6's broken and incomplete CSS2. */
281 }
287 }
293 }
297 }
302 }
304 /* IE6 sets dynamically generated links as visited. */
306 </style>
308 </head>
309 <body>
311 <h1>
312 git-filter-branch(1) Manual Page
313 </h1>
316 <p>git-filter-branch -
317 Rewrite branches
318 </p>
319 </div>
320 </div>
324 <div class="content"><em>git filter-branch</em> [--env-filter <command>] [--tree-filter <command>]
328 [--prune-empty]
331 </div>
336 Those filters can modify each tree (e.g. removing a file or running
337 a perl rewrite on all files) or information about each commit.
338 Otherwise, all information (including original commit times or merge
339 information) will be preserved.</p></div>
342 If you specify no filters, the commits will be recommitted without any
343 changes, which would normally have no effect. Nevertheless, this may be
344 useful in the future for compensating for some git bugs or such,
345 therefore such a usage is permitted.</p></div>
346 <div class="para"><p><strong>NOTE</strong>: This command honors <tt>.git/info/grafts</tt>. If you have any grafts
347 defined, running this command will make them permanent.</p></div>
348 <div class="para"><p><strong>WARNING</strong>! The rewritten history will have different object names for all
349 the objects and will not converge with the original branch. You will not
350 be able to easily push and distribute the rewritten branch on top of the
351 original branch. Please do not use this command if you do not know the
352 full implications, and avoid using it anyway, if a simple single commit
353 would suffice to fix your problem. (See the "RECOVERING FROM UPSTREAM
355 rewriting published history.)</p></div>
357 if different from the rewritten ones, will be stored in the namespace
360 be a good idea to redirect the temporary directory off-disk with the
365 (with the notable exception of the commit filter, for technical reasons).
366 Prior to that, the $GIT_COMMIT environment variable will be set to contain
367 the id of the commit being rewritten. Also, GIT_AUTHOR_NAME,
368 GIT_AUTHOR_EMAIL, GIT_AUTHOR_DATE, GIT_COMMITTER_NAME, GIT_COMMITTER_EMAIL,
369 and GIT_COMMITTER_DATE are set according to the current commit. The values
370 of these variables after the filters have run, are used for the new commit.
372 operation will be aborted.</p></div>
373 <div class="para"><p>A <em>map</em> function is available that takes an "original sha1 id" argument
374 and outputs a "rewritten sha1 id" if the commit has been already
376 return several ids on separate lines if your commit filter emitted
377 multiple commits.</p></div>
378 </div>
382 <dt>
384 </dt>
385 <dd>
386 <p>
387 This filter may be used if you only need to modify the environment
388 in which the commit will be performed. Specifically, you might
389 want to rewrite the author/committer name/email/time environment
391 to re-export the variables.
392 </p>
393 </dd>
394 <dt>
396 </dt>
397 <dd>
398 <p>
399 This is the filter for rewriting the tree and its contents.
400 The argument is evaluated in shell with the working
401 directory set to the root of the checked out tree. The new tree
402 is then used as-is (new files are auto-added, disappeared files
403 are auto-removed - neither .gitignore files nor any other ignore
405 </p>
406 </dd>
407 <dt>
409 </dt>
410 <dd>
411 <p>
412 This is the filter for rewriting the index. It is similar to the
413 tree filter but does not check out the tree, which makes it much
414 faster. Frequently used with <tt>git rm --cached
417 </p>
418 </dd>
419 <dt>
421 </dt>
422 <dd>
423 <p>
424 This is the filter for rewriting the commit's parent list.
425 It will receive the parent string on stdin and shall output
426 the new parent string on stdout. The parent string is in
428 the initial commit, "-p parent" for a normal commit and
429 "-p parent1 -p parent2 -p parent3 …" for a merge commit.
430 </p>
431 </dd>
432 <dt>
434 </dt>
435 <dd>
436 <p>
437 This is the filter for rewriting the commit messages.
438 The argument is evaluated in the shell with the original
439 commit message on standard input; its standard output is
440 used as the new commit message.
441 </p>
442 </dd>
443 <dt>
445 </dt>
446 <dd>
447 <p>
448 This is the filter for performing the commit.
449 If this filter is specified, it will be called instead of the
451 "<TREE_ID> [-p <PARENT_COMMIT_ID>]…" and the log message on
452 stdin. The commit id is expected on stdout.
453 </p>
455 commit ids; in that case, the rewritten children of the original commit will
456 have all of them as parents.</p></div>
457 <div class="para"><p>You can use the <em>map</em> convenience function in this filter, and other
459 will leave out the current commit (but not its changes! If you want
463 and that makes no change to the tree.</p></div>
464 </dd>
465 <dt>
467 </dt>
468 <dd>
469 <p>
470 This is the filter for rewriting tag names. When passed,
471 it will be called for every tag ref that points to a rewritten
472 object (or to a tag object which points to a rewritten object).
473 The original tag name is passed via standard input, and the new
474 tag name is expected on standard output.
475 </p>
477 use "--tag-name-filter cat" to simply update the tags. In this
478 case, be very careful and make sure you have the old tags
479 backed up in case the conversion has run afoul.</p></div>
481 a message attached, a new tag object will be created with the same message,
482 author, and timestamp. If the tag has a signature attached, the
483 signature will be stripped. It is by definition impossible to preserve
484 signatures. The reason this is "nearly" proper, is because ideally if
485 the tag did not change (points to the same object, has the same name, etc.)
486 it should retain any signature. That is not the case, signatures will always
487 be removed, buyer beware. There is also no support for changing the
488 author or timestamp (or the tag message for that matter). Tags which point
489 to other tags will be rewritten to point to the underlying commit.</p></div>
490 </dd>
491 <dt>
493 </dt>
494 <dd>
495 <p>
496 Only look at the history which touches the given subdirectory.
497 The result will contain that directory (and only that) as its
498 project root. Implies --remap-to-ancestor.
499 </p>
500 </dd>
501 <dt>
502 --remap-to-ancestor
503 </dt>
504 <dd>
505 <p>
506 Rewrite refs to the nearest rewritten ancestor instead of
507 ignoring them.
508 </p>
510 commit they point to was rewritten. However, you can limit the extent
512 limiters. Refs pointing to such excluded commits would then normally
513 be ignored. With this option, they are instead rewritten to point at
514 the nearest ancestor that was not excluded.</p></div>
515 </dd>
516 <dt>
517 --prune-empty
518 </dt>
519 <dd>
520 <p>
521 Some kind of filters will generate empty commits, that left the tree
522 untouched. This switch allow git-filter-branch to ignore such
523 commits. Though, this switch only applies for commits that have one
524 and only one parent, it will hence keep merges points. Also, this
528 happen.
529 </p>
530 </dd>
531 <dt>
533 </dt>
534 <dd>
535 <p>
536 Use this option to set the namespace where the original commits
538 </p>
539 </dd>
540 <dt>
542 </dt>
543 <dd>
544 <p>
545 Use this option to set the path to the temporary directory used for
546 rewriting. When applying a tree filter, the command needs to
547 temporarily check out the tree to some directory, which may consume
548 considerable space in case of large projects. By default it
550 that choice by this parameter.
551 </p>
552 </dd>
553 <dt>
554 -f
555 </dt>
556 <dt>
557 --force
558 </dt>
559 <dd>
560 <p>
562 directory or when there are already refs starting with
564 </p>
565 </dd>
566 <dt>
568 </dt>
569 <dd>
570 <p>
572 these options are rewritten. You may also specify options
575 </p>
576 </dd>
577 </dl></div>
578 </div>
582 or copyright violation) from all commits:</p></div>
586 </div></div>
590 <div class="para"><p>Using <tt>--index-filter</tt> with <em>git rm</em> yields a significantly faster
592 will fail if the file is absent from the tree of a commit. If you
593 want to "completely forget" a file, it does not matter when it entered
597 <pre><tt>git filter-branch --index-filter 'git rm --cached --ignore-unmatch filename' HEAD</tt></pre>
598 </div></div>
600 <div class="para"><p>To rewrite the repository to look as if <tt>foodir/</tt> had been its project
601 root, and discard all other history:</p></div>
605 </div></div>
610 history) to be the parent of the current initial commit, in
611 order to paste the other history behind the current history:</p></div>
615 </div></div>
617 the initial commit - add graftcommit as a parent). Note that this assumes
618 history with a single root (that is, no merge without common ancestors
619 happened). If this is not the case, use:</p></div>
622 <pre><tt>git filter-branch --parent-filter \
623 'test $GIT_COMMIT = <commit-id> && echo "-p <graft-id>" || cat' HEAD</tt></pre>
624 </div></div>
629 git filter-branch $graft-id..HEAD</tt></pre>
630 </div></div>
634 <pre><tt>git filter-branch --commit-filter '
636 then
637 skip_commit "$@";
638 else
639 git commit-tree "$@";
640 fi' HEAD</tt></pre>
641 </div></div>
645 <pre><tt>skip_commit()
646 {
647 shift;
648 while [ -n "$1" ];
649 do
650 shift;
651 map "$1";
652 shift;
653 done;
654 }</tt></pre>
655 </div></div>
657 parameters. Note that this handles merges properly! In case Darl
658 committed a merge between P1 and P2, it will be propagated properly
659 and all children of the merge will become merge commits with P1,P2
660 as their parents instead of the merge commit.</p></div>
663 be removed this way:</p></div>
666 <pre><tt>git filter-branch --msg-filter '
667 sed -e "/^git-svn-id:/d"
668 '</tt></pre>
669 </div></div>
671 range in addition to the new branch name. The new branch name will
673 will print.</p></div>
674 <div class="para"><p>If you need to add <em>Acked-by</em> lines to, say, the last 10 commits (none
675 of which is a merge), use this command:</p></div>
678 <pre><tt>git filter-branch --msg-filter '
679 cat &&
680 echo "Acked-by: Bugs Bunny <bunny@bugzilla.org>"
682 </div></div>
683 <div class="para"><p><strong>NOTE</strong> the changes introduced by the commits, and which are not reverted
684 by subsequent commits, will still be in the rewritten branch. If you want
685 to throw out _changes_ together with the commits, you should use the
690 <pre><tt> D--E--F--G--H
691 / /
692 A--B-----C</tt></pre>
693 </div></div>
694 <div class="para"><p>To rewrite only commits D,E,F,G,H, but leave A, B and C alone, use:</p></div>
698 </div></div>
702 <pre><tt>git filter-branch ... C..H --not D
703 git filter-branch ... D..H --not C</tt></pre>
704 </div></div>
705 <div class="para"><p>To move the whole tree into a subdirectory, or remove it from there:</p></div>
708 <pre><tt>git filter-branch --index-filter \
710 GIT_INDEX_FILE=$GIT_INDEX_FILE.new \
711 git update-index --index-info &&
712 mv $GIT_INDEX_FILE.new $GIT_INDEX_FILE' HEAD</tt></pre>
713 </div></div>
714 </div>
718 usually with some combination of <tt>--index-filter</tt> and
719 <tt>--subdirectory-filter</tt>. People expect the resulting repository to
720 be smaller than the original, but you need a few more steps to
721 actually make it smaller, because git tries hard not to lose your
722 objects until you tell it to. First make sure that:</p></div>
724 <li>
725 <p>
726 You really removed all variants of a filename, if a blob was moved
727 over its lifetime. <tt>git log --name-only --follow --all --
728 filename</tt> can help you find renames.
729 </p>
730 </li>
731 <li>
732 <p>
733 You really filtered all refs: use <tt>--tag-name-filter cat --
734 --all</tt> when calling git-filter-branch.
735 </p>
736 </li>
737 </ul></div>
739 to clone, that keeps your original intact.</p></div>
741 <li>
742 <p>
743 Clone it with <tt>git clone file:///path/to/repo</tt>. The clone
745 that cloning with a plain path just hardlinks everything!)
746 </p>
747 </li>
748 </ul></div>
750 following points instead (in this order). This is a very destructive
751 approach, so <strong>make a backup</strong> or go back to cloning it. You have been
752 warned.</p></div>
754 <li>
755 <p>
756 Remove the original refs backed up by git-filter-branch: say <tt>git
758 update-ref -d</tt>.
759 </p>
760 </li>
761 <li>
762 <p>
763 Expire all reflogs with <tt>git reflog expire --expire=now --all</tt>.
764 </p>
765 </li>
766 <li>
767 <p>
768 Garbage collect all unreferenced objects with <tt>git gc --prune=now</tt>
769 (or if your git-gc is not new enough to support arguments to
770 <tt>--prune</tt>, use <tt>git repack -ad; git prune</tt> instead).
771 </p>
772 </li>
773 </ul></div>
774 </div>
778 and the git list <git@vger.kernel.org></p></div>
779 </div>
783 </div>
787 </div>
790 Last updated 2010-02-13 00:59:43 UTC
791 </div>
792 </div>
793 </body>
794 </html>