| <?xml version="1.0" encoding="UTF-8"?> | |
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" | |
| "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> | |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> | |
| <head> | |
| <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" /> | |
| <meta name="generator" content="AsciiDoc 8.6.10" /> | |
| <title>git-filter-branch(1)</title> | |
| <style type="text/css"> | |
| /* Shared CSS for AsciiDoc xhtml11 and html5 backends */ | |
| /* Default font. */ | |
| body { | |
| font-family: Georgia,serif; | |
| } | |
| /* Title font. */ | |
| h1, h2, h3, h4, h5, h6, | |
| div.title, caption.title, | |
| thead, p.table.header, | |
| #toctitle, | |
| #author, #revnumber, #revdate, #revremark, | |
| #footer { | |
| font-family: Arial,Helvetica,sans-serif; | |
| } | |
| body { | |
| margin: 1em 5% 1em 5%; | |
| } | |
| a { | |
| color: blue; | |
| text-decoration: underline; | |
| } | |
| a:visited { | |
| color: fuchsia; | |
| } | |
| em { | |
| font-style: italic; | |
| color: navy; | |
| } | |
| strong { | |
| font-weight: bold; | |
| color: #083194; | |
| } | |
| h1, h2, h3, h4, h5, h6 { | |
| color: #527bbd; | |
| margin-top: 1.2em; | |
| margin-bottom: 0.5em; | |
| line-height: 1.3; | |
| } | |
| h1, h2, h3 { | |
| border-bottom: 2px solid silver; | |
| } | |
| h2 { | |
| padding-top: 0.5em; | |
| } | |
| h3 { | |
| float: left; | |
| } | |
| h3 + * { | |
| clear: left; | |
| } | |
| h5 { | |
| font-size: 1.0em; | |
| } | |
| div.sectionbody { | |
| margin-left: 0; | |
| } | |
| hr { | |
| border: 1px solid silver; | |
| } | |
| p { | |
| margin-top: 0.5em; | |
| margin-bottom: 0.5em; | |
| } | |
| ul, ol, li > p { | |
| margin-top: 0; | |
| } | |
| ul > li { color: #aaa; } | |
| ul > li > * { color: black; } | |
| .monospaced, code, pre { | |
| font-family: "Courier New", Courier, monospace; | |
| font-size: inherit; | |
| color: navy; | |
| padding: 0; | |
| margin: 0; | |
| } | |
| pre { | |
| white-space: pre-wrap; | |
| } | |
| #author { | |
| color: #527bbd; | |
| font-weight: bold; | |
| font-size: 1.1em; | |
| } | |
| #email { | |
| } | |
| #revnumber, #revdate, #revremark { | |
| } | |
| #footer { | |
| font-size: small; | |
| border-top: 2px solid silver; | |
| padding-top: 0.5em; | |
| margin-top: 4.0em; | |
| } | |
| #footer-text { | |
| float: left; | |
| padding-bottom: 0.5em; | |
| } | |
| #footer-badges { | |
| float: right; | |
| padding-bottom: 0.5em; | |
| } | |
| #preamble { | |
| margin-top: 1.5em; | |
| margin-bottom: 1.5em; | |
| } | |
| div.imageblock, div.exampleblock, div.verseblock, | |
| div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock, | |
| div.admonitionblock { | |
| margin-top: 1.0em; | |
| margin-bottom: 1.5em; | |
| } | |
| div.admonitionblock { | |
| margin-top: 2.0em; | |
| margin-bottom: 2.0em; | |
| margin-right: 10%; | |
| color: #606060; | |
| } | |
| div.content { /* Block element content. */ | |
| padding: 0; | |
| } | |
| /* Block element titles. */ | |
| div.title, caption.title { | |
| color: #527bbd; | |
| font-weight: bold; | |
| text-align: left; | |
| margin-top: 1.0em; | |
| margin-bottom: 0.5em; | |
| } | |
| div.title + * { | |
| margin-top: 0; | |
| } | |
| td div.title:first-child { | |
| margin-top: 0.0em; | |
| } | |
| div.content div.title:first-child { | |
| margin-top: 0.0em; | |
| } | |
| div.content + div.title { | |
| margin-top: 0.0em; | |
| } | |
| div.sidebarblock > div.content { | |
| background: #ffffee; | |
| border: 1px solid #dddddd; | |
| border-left: 4px solid #f0f0f0; | |
| padding: 0.5em; | |
| } | |
| div.listingblock > div.content { | |
| border: 1px solid #dddddd; | |
| border-left: 5px solid #f0f0f0; | |
| background: #f8f8f8; | |
| padding: 0.5em; | |
| } | |
| div.quoteblock, div.verseblock { | |
| padding-left: 1.0em; | |
| margin-left: 1.0em; | |
| margin-right: 10%; | |
| border-left: 5px solid #f0f0f0; | |
| color: #888; | |
| } | |
| div.quoteblock > div.attribution { | |
| padding-top: 0.5em; | |
| text-align: right; | |
| } | |
| div.verseblock > pre.content { | |
| font-family: inherit; | |
| font-size: inherit; | |
| } | |
| div.verseblock > div.attribution { | |
| padding-top: 0.75em; | |
| text-align: left; | |
| } | |
| /* DEPRECATED: Pre version 8.2.7 verse style literal block. */ | |
| div.verseblock + div.attribution { | |
| text-align: left; | |
| } | |
| div.admonitionblock .icon { | |
| vertical-align: top; | |
| font-size: 1.1em; | |
| font-weight: bold; | |
| text-decoration: underline; | |
| color: #527bbd; | |
| padding-right: 0.5em; | |
| } | |
| div.admonitionblock td.content { | |
| padding-left: 0.5em; | |
| border-left: 3px solid #dddddd; | |
| } | |
| div.exampleblock > div.content { | |
| border-left: 3px solid #dddddd; | |
| padding-left: 0.5em; | |
| } | |
| div.imageblock div.content { padding-left: 0; } | |
| span.image img { border-style: none; vertical-align: text-bottom; } | |
| a.image:visited { color: white; } | |
| dl { | |
| margin-top: 0.8em; | |
| margin-bottom: 0.8em; | |
| } | |
| dt { | |
| margin-top: 0.5em; | |
| margin-bottom: 0; | |
| font-style: normal; | |
| color: navy; | |
| } | |
| dd > *:first-child { | |
| margin-top: 0.1em; | |
| } | |
| ul, ol { | |
| list-style-position: outside; | |
| } | |
| ol.arabic { | |
| list-style-type: decimal; | |
| } | |
| ol.loweralpha { | |
| list-style-type: lower-alpha; | |
| } | |
| ol.upperalpha { | |
| list-style-type: upper-alpha; | |
| } | |
| ol.lowerroman { | |
| list-style-type: lower-roman; | |
| } | |
| ol.upperroman { | |
| list-style-type: upper-roman; | |
| } | |
| div.compact ul, div.compact ol, | |
| div.compact p, div.compact p, | |
| div.compact div, div.compact div { | |
| margin-top: 0.1em; | |
| margin-bottom: 0.1em; | |
| } | |
| tfoot { | |
| font-weight: bold; | |
| } | |
| td > div.verse { | |
| white-space: pre; | |
| } | |
| div.hdlist { | |
| margin-top: 0.8em; | |
| margin-bottom: 0.8em; | |
| } | |
| div.hdlist tr { | |
| padding-bottom: 15px; | |
| } | |
| dt.hdlist1.strong, td.hdlist1.strong { | |
| font-weight: bold; | |
| } | |
| td.hdlist1 { | |
| vertical-align: top; | |
| font-style: normal; | |
| padding-right: 0.8em; | |
| color: navy; | |
| } | |
| td.hdlist2 { | |
| vertical-align: top; | |
| } | |
| div.hdlist.compact tr { | |
| margin: 0; | |
| padding-bottom: 0; | |
| } | |
| .comment { | |
| background: yellow; | |
| } | |
| .footnote, .footnoteref { | |
| font-size: 0.8em; | |
| } | |
| span.footnote, span.footnoteref { | |
| vertical-align: super; | |
| } | |
| #footnotes { | |
| margin: 20px 0 20px 0; | |
| padding: 7px 0 0 0; | |
| } | |
| #footnotes div.footnote { | |
| margin: 0 0 5px 0; | |
| } | |
| #footnotes hr { | |
| border: none; | |
| border-top: 1px solid silver; | |
| height: 1px; | |
| text-align: left; | |
| margin-left: 0; | |
| width: 20%; | |
| min-width: 100px; | |
| } | |
| div.colist td { | |
| padding-right: 0.5em; | |
| padding-bottom: 0.3em; | |
| vertical-align: top; | |
| } | |
| div.colist td img { | |
| margin-top: 0.3em; | |
| } | |
| @media print { | |
| #footer-badges { display: none; } | |
| } | |
| #toc { | |
| margin-bottom: 2.5em; | |
| } | |
| #toctitle { | |
| color: #527bbd; | |
| font-size: 1.1em; | |
| font-weight: bold; | |
| margin-top: 1.0em; | |
| margin-bottom: 0.1em; | |
| } | |
| div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 { | |
| margin-top: 0; | |
| margin-bottom: 0; | |
| } | |
| div.toclevel2 { | |
| margin-left: 2em; | |
| font-size: 0.9em; | |
| } | |
| div.toclevel3 { | |
| margin-left: 4em; | |
| font-size: 0.9em; | |
| } | |
| div.toclevel4 { | |
| margin-left: 6em; | |
| font-size: 0.9em; | |
| } | |
| span.aqua { color: aqua; } | |
| span.black { color: black; } | |
| span.blue { color: blue; } | |
| span.fuchsia { color: fuchsia; } | |
| span.gray { color: gray; } | |
| span.green { color: green; } | |
| span.lime { color: lime; } | |
| span.maroon { color: maroon; } | |
| span.navy { color: navy; } | |
| span.olive { color: olive; } | |
| span.purple { color: purple; } | |
| span.red { color: red; } | |
| span.silver { color: silver; } | |
| span.teal { color: teal; } | |
| span.white { color: white; } | |
| span.yellow { color: yellow; } | |
| span.aqua-background { background: aqua; } | |
| span.black-background { background: black; } | |
| span.blue-background { background: blue; } | |
| span.fuchsia-background { background: fuchsia; } | |
| span.gray-background { background: gray; } | |
| span.green-background { background: green; } | |
| span.lime-background { background: lime; } | |
| span.maroon-background { background: maroon; } | |
| span.navy-background { background: navy; } | |
| span.olive-background { background: olive; } | |
| span.purple-background { background: purple; } | |
| span.red-background { background: red; } | |
| span.silver-background { background: silver; } | |
| span.teal-background { background: teal; } | |
| span.white-background { background: white; } | |
| span.yellow-background { background: yellow; } | |
| span.big { font-size: 2em; } | |
| span.small { font-size: 0.6em; } | |
| span.underline { text-decoration: underline; } | |
| span.overline { text-decoration: overline; } | |
| span.line-through { text-decoration: line-through; } | |
| div.unbreakable { page-break-inside: avoid; } | |
| /* | |
| * xhtml11 specific | |
| * | |
| * */ | |
| div.tableblock { | |
| margin-top: 1.0em; | |
| margin-bottom: 1.5em; | |
| } | |
| div.tableblock > table { | |
| border: 3px solid #527bbd; | |
| } | |
| thead, p.table.header { | |
| font-weight: bold; | |
| color: #527bbd; | |
| } | |
| p.table { | |
| margin-top: 0; | |
| } | |
| /* Because the table frame attribute is overriden by CSS in most browsers. */ | |
| div.tableblock > table[frame="void"] { | |
| border-style: none; | |
| } | |
| div.tableblock > table[frame="hsides"] { | |
| border-left-style: none; | |
| border-right-style: none; | |
| } | |
| div.tableblock > table[frame="vsides"] { | |
| border-top-style: none; | |
| border-bottom-style: none; | |
| } | |
| /* | |
| * html5 specific | |
| * | |
| * */ | |
| table.tableblock { | |
| margin-top: 1.0em; | |
| margin-bottom: 1.5em; | |
| } | |
| thead, p.tableblock.header { | |
| font-weight: bold; | |
| color: #527bbd; | |
| } | |
| p.tableblock { | |
| margin-top: 0; | |
| } | |
| table.tableblock { | |
| border-width: 3px; | |
| border-spacing: 0px; | |
| border-style: solid; | |
| border-color: #527bbd; | |
| border-collapse: collapse; | |
| } | |
| th.tableblock, td.tableblock { | |
| border-width: 1px; | |
| padding: 4px; | |
| border-style: solid; | |
| border-color: #527bbd; | |
| } | |
| table.tableblock.frame-topbot { | |
| border-left-style: hidden; | |
| border-right-style: hidden; | |
| } | |
| table.tableblock.frame-sides { | |
| border-top-style: hidden; | |
| border-bottom-style: hidden; | |
| } | |
| table.tableblock.frame-none { | |
| border-style: hidden; | |
| } | |
| th.tableblock.halign-left, td.tableblock.halign-left { | |
| text-align: left; | |
| } | |
| th.tableblock.halign-center, td.tableblock.halign-center { | |
| text-align: center; | |
| } | |
| th.tableblock.halign-right, td.tableblock.halign-right { | |
| text-align: right; | |
| } | |
| th.tableblock.valign-top, td.tableblock.valign-top { | |
| vertical-align: top; | |
| } | |
| th.tableblock.valign-middle, td.tableblock.valign-middle { | |
| vertical-align: middle; | |
| } | |
| th.tableblock.valign-bottom, td.tableblock.valign-bottom { | |
| vertical-align: bottom; | |
| } | |
| /* | |
| * manpage specific | |
| * | |
| * */ | |
| body.manpage h1 { | |
| padding-top: 0.5em; | |
| padding-bottom: 0.5em; | |
| border-top: 2px solid silver; | |
| border-bottom: 2px solid silver; | |
| } | |
| body.manpage h2 { | |
| border-style: none; | |
| } | |
| body.manpage div.sectionbody { | |
| margin-left: 3em; | |
| } | |
| @media print { | |
| body.manpage div#toc { display: none; } | |
| } | |
| </style> | |
| <script type="text/javascript"> | |
| /*<+'])'); | |
| // Function that scans the DOM tree for header elements (the DOM2 | |
| // nodeIterator API would be a better technique but not supported by all | |
| // browsers). | |
| var iterate = function (el) { | |
| for (var i = el.firstChild; i != null; i = i.nextSibling) { | |
| if (i.nodeType == 1 /* Node.ELEMENT_NODE */) { | |
| var mo = re.exec(i.tagName); | |
| if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") { | |
| result[result.length] = new TocEntry(i, getText(i), mo[1]-1); | |
| } | |
| iterate(i); | |
| } | |
| } | |
| } | |
| iterate(el); | |
| return result; | |
| } | |
| var toc = document.getElementById("toc"); | |
| if (!toc) { | |
| return; | |
| } | |
| // Delete existing TOC entries in case we're reloading the TOC. | |
| var tocEntriesToRemove = []; | |
| var i; | |
| for (i = 0; i < toc.childNodes.length; i++) { | |
| var entry = toc.childNodes[i]; | |
| if (entry.nodeName.toLowerCase() == 'div' | |
| && entry.getAttribute("class") | |
| && entry.getAttribute("class").match(/^toclevel/)) | |
| tocEntriesToRemove.push(entry); | |
| } | |
| for (i = 0; i < tocEntriesToRemove.length; i++) { | |
| toc.removeChild(tocEntriesToRemove[i]); | |
| } | |
| // Rebuild TOC entries. | |
| var entries = tocEntries(document.getElementById("content"), toclevels); | |
| for (var i = 0; i < entries.length; ++i) { | |
| var entry = entries[i]; | |
| if (entry.element.id == "") | |
| entry.element.id = "_toc_" + i; | |
| var a = document.createElement("a"); | |
| a.href = "#" + entry.element.id; | |
| a.appendChild(document.createTextNode(entry.text)); | |
| var div = document.createElement("div"); | |
| div.appendChild(a); | |
| div.className = "toclevel" + entry.toclevel; | |
| toc.appendChild(div); | |
| } | |
| if (entries.length == 0) | |
| toc.parentNode.removeChild(toc); | |
| }, | |
| ///////////////////////////////////////////////////////////////////// | |
| // Footnotes generator | |
| ///////////////////////////////////////////////////////////////////// | |
| /* Based on footnote generation code from: | |
| * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html | |
| */ | |
| footnotes: function () { | |
| // Delete existing footnote entries in case we're reloading the footnodes. | |
| var i; | |
| var noteholder = document.getElementById("footnotes"); | |
| if (!noteholder) { | |
| return; | |
| } | |
| var entriesToRemove = []; | |
| for (i = 0; i < noteholder.childNodes.length; i++) { | |
| var entry = noteholder.childNodes[i]; | |
| if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote") | |
| entriesToRemove.push(entry); | |
| } | |
| for (i = 0; i < entriesToRemove.length; i++) { | |
| noteholder.removeChild(entriesToRemove[i]); | |
| } | |
| // Rebuild footnote entries. | |
| var cont = document.getElementById("content"); | |
| var spans = cont.getElementsByTagName("span"); | |
| var refs = {}; | |
| var n = 0; | |
| for (i=0; i<spans.length; i++) { | |
| if (spans[i].className == "footnote") { | |
| n++; | |
| var note = spans[i].getAttribute("data-note"); | |
| if (!note) { | |
| // Use [\s\S] in place of . so multi-line matches work. | |
| // Because JavaScript has no s (dotall) regex flag. | |
| note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1]; | |
| spans[i].innerHTML = | |
| "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n + | |
| "' title='View footnote' class='footnote'>" + n + "</a>]"; | |
| spans[i].setAttribute("data-note", note); | |
| } | |
| noteholder.innerHTML += | |
| "<div class='footnote' id='_footnote_" + n + "'>" + | |
| "<a href='#_footnoteref_" + n + "' title='Return to text'>" + | |
| n + "</a>. " + note + "</div>"; | |
| var id =spans[i].getAttribute("id"); | |
| if (id != null) refs["#"+id] = n; | |
| } | |
| } | |
| if (n == 0) | |
| noteholder.parentNode.removeChild(noteholder); | |
| else { | |
| // Process footnoterefs. | |
| for (i=0; i<spans.length; i++) { | |
| if (spans[i].className == "footnoteref") { | |
| var href = spans[i].getElementsByTagName("a")[0].getAttribute("href"); | |
| href = href.match(/#.*/)[0]; // Because IE return full URL. | |
| n = refs[href]; | |
| spans[i].innerHTML = | |
| "[<a href='#_footnote_" + n + | |
| "' title='View footnote' class='footnote'>" + n + "</a>]"; | |
| } | |
| } | |
| } | |
| }, | |
| install: function(toclevels) { | |
| var timerId; | |
| function reinstall() { | |
| asciidoc.footnotes(); | |
| if (toclevels) { | |
| asciidoc.toc(toclevels); | |
| } | |
| } | |
| function reinstallAndRemoveTimer() { | |
| clearInterval(timerId); | |
| reinstall(); | |
| } | |
| timerId = setInterval(reinstall, 500); | |
| if (document.addEventListener) | |
| document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false); | |
| else | |
| window.onload = reinstallAndRemoveTimer; | |
| } | |
| } | |
| asciidoc.install(); | |
| /*]]>*/ | |
| </script> | |
| </head> | |
| <body class="manpage"> | |
| <div id="header"> | |
| <h1> | |
| git-filter-branch(1) Manual Page | |
| </h1> | |
| <h2>NAME</h2> | |
| <div class="sectionbody"> | |
| <p>git-filter-branch - | |
| Rewrite branches | |
| </p> | |
| </div> | |
| </div> | |
| <div id="content"> | |
| <div class="sect1"> | |
| <h2 id="_synopsis">SYNOPSIS</h2> | |
| <div class="sectionbody"> | |
| <div class="verseblock"> | |
| <pre class="content"><em>git filter-branch</em> [--setup <command>] [--subdirectory-filter <directory>] | |
| [--env-filter <command>] [--tree-filter <command>] | |
| [--index-filter <command>] [--parent-filter <command>] | |
| [--msg-filter <command>] [--commit-filter <command>] | |
| [--tag-name-filter <command>] [--prune-empty] | |
| [--original <namespace>] [-d <directory>] [-f | --force] | |
| [--state-branch <branch>] [--] [<rev-list options>…]</pre> | |
| <div class="attribution"> | |
| </div></div> | |
| </div> | |
| </div> | |
| <div class="sect1"> | |
| <h2 id="_description">DESCRIPTION</h2> | |
| <div class="sectionbody"> | |
| <div class="paragraph"><p>Lets you rewrite Git revision history by rewriting the branches mentioned | |
| in the <rev-list options>, 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></div> | |
| <div class="paragraph"><p>The command will only rewrite the <em>positive</em> refs mentioned in the | |
| command line (e.g. 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></div> | |
| <div class="paragraph"><p><strong>NOTE</strong>: This command honors <code>.git/info/grafts</code> file and refs in | |
| the <code>refs/replace/</code> namespace. | |
| If you have any grafts or replacement refs defined, running this command | |
| will make them permanent.</p></div> | |
| <div class="paragraph"><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 | |
| original branch. Please do not use this command if you do not know the | |
| full implications, and avoid using it anyway, if a simple single commit | |
| would suffice to fix your problem. (See the "RECOVERING FROM UPSTREAM | |
| REBASE" section in <a href="git-rebase.html">git-rebase(1)</a> for further information about | |
| rewriting published history.)</p></div> | |
| <div class="paragraph"><p>Always verify that the rewritten version is correct: The original refs, | |
| if different from the rewritten ones, will be stored in the namespace | |
| <em>refs/original/</em>.</p></div> | |
| <div class="paragraph"><p>Note that since this operation is very I/O expensive, it might | |
| be a good idea to redirect the temporary directory off-disk with the | |
| <code>-d</code> option, e.g. on tmpfs. Reportedly the speedup is very noticeable.</p></div> | |
| <div class="sect2"> | |
| <h3 id="_filters">Filters</h3> | |
| <div class="paragraph"><p>The filters are applied in the order as listed below. The <command> | |
| argument is always evaluated in the shell context using the <em>eval</em> command | |
| (with the notable exception of the commit filter, for technical reasons). | |
| Prior to that, the <code>$GIT_COMMIT</code> environment variable will be set to contain | |
| the id of the commit being rewritten. Also, GIT_AUTHOR_NAME, | |
| GIT_AUTHOR_EMAIL, GIT_AUTHOR_DATE, GIT_COMMITTER_NAME, GIT_COMMITTER_EMAIL, | |
| and GIT_COMMITTER_DATE are taken from the current commit and exported to | |
| the environment, in order to affect the author and committer identities of | |
| the replacement commit created by <a href="git-commit-tree.html">git-commit-tree(1)</a> after the | |
| filters have run.</p></div> | |
| <div class="paragraph"><p>If any evaluation of <command> returns a non-zero exit status, the whole | |
| operation will be aborted.</p></div> | |
| <div class="paragraph"><p>A <em>map</em> function is available that takes an "original sha1 id" argument | |
| and outputs a "rewritten sha1 id" if the commit has been already | |
| rewritten, and "original sha1 id" otherwise; the <em>map</em> function can | |
| return several ids on separate lines if your commit filter emitted | |
| multiple commits.</p></div> | |
| </div> | |
| </div> | |
| </div> | |
| <div class="sect1"> | |
| <h2 id="_options">OPTIONS</h2> | |
| <div class="sectionbody"> | |
| <div class="dlist"><dl> | |
| <dt class="hdlist1"> | |
| --setup <command> | |
| </dt> | |
| <dd> | |
| <p> | |
| This is not a real filter executed for each commit but a one | |
| time setup just before the loop. Therefore no commit-specific | |
| variables are defined yet. Functions or variables defined here | |
| can be used or modified in the following filter steps except | |
| the commit filter, for technical reasons. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --subdirectory-filter <directory> | |
| </dt> | |
| <dd> | |
| <p> | |
| Only look at the history which touches the given subdirectory. | |
| The result will contain that directory (and only that) as its | |
| project root. Implies <a href="#Remap_to_ancestor">[Remap_to_ancestor]</a>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --env-filter <command> | |
| </dt> | |
| <dd> | |
| <p> | |
| This filter may be used if you only need to modify the environment | |
| in which the commit will be performed. Specifically, you might | |
| want to rewrite the author/committer name/email/time environment | |
| variables (see <a href="git-commit-tree.html">git-commit-tree(1)</a> for details). | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --tree-filter <command> | |
| </dt> | |
| <dd> | |
| <p> | |
| This is the filter for rewriting the tree and its contents. | |
| The argument is evaluated in shell with the working | |
| directory set to the root of the checked out tree. The new tree | |
| is then used as-is (new files are auto-added, disappeared files | |
| are auto-removed - neither .gitignore files nor any other ignore | |
| rules <strong>HAVE ANY EFFECT</strong>!). | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --index-filter <command> | |
| </dt> | |
| <dd> | |
| <p> | |
| This is the filter for rewriting the index. It is similar to the | |
| tree filter but does not check out the tree, which makes it much | |
| faster. Frequently used with <code>git rm --cached | |
| --ignore-unmatch ...</code>, see EXAMPLES below. For hairy | |
| cases, see <a href="git-update-index.html">git-update-index(1)</a>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --parent-filter <command> | |
| </dt> | |
| <dd> | |
| <p> | |
| This is the filter for rewriting the commit’s parent list. | |
| It will receive the parent string on stdin and shall output | |
| the new parent string on stdout. The parent string is in | |
| the format described in <a href="git-commit-tree.html">git-commit-tree(1)</a>: empty for | |
| the initial commit, "-p parent" for a normal commit and | |
| "-p parent1 -p parent2 -p parent3 …" for a merge commit. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --msg-filter <command> | |
| </dt> | |
| <dd> | |
| <p> | |
| This is the filter for rewriting the commit messages. | |
| The argument is evaluated in the shell with the original | |
| commit message on standard input; its standard output is | |
| used as the new commit message. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --commit-filter <command> | |
| </dt> | |
| <dd> | |
| <p> | |
| This is the filter for performing the commit. | |
| If this filter is specified, it will be called instead of the | |
| <em>git commit-tree</em> command, with arguments of the form | |
| "<TREE_ID> [(-p <PARENT_COMMIT_ID>)…]" and the log message on | |
| stdin. The commit id is expected on stdout. | |
| </p> | |
| <div class="paragraph"><p>As a special extension, the commit filter may emit multiple | |
| commit ids; in that case, the rewritten children of the original commit will | |
| have all of them as parents.</p></div> | |
| <div class="paragraph"><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 <em>git rebase</em> instead).</p></div> | |
| <div class="paragraph"><p>You can also use the <code>git_commit_non_empty_tree "$@"</code> instead of | |
| <code>git commit-tree "$@"</code> if you don’t wish to keep commits with a single parent | |
| and that makes no change to the tree.</p></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --tag-name-filter <command> | |
| </dt> | |
| <dd> | |
| <p> | |
| This is the filter for rewriting tag names. When passed, | |
| it will be called for every tag ref that points to a rewritten | |
| object (or to a tag object which points to a rewritten object). | |
| The original tag name is passed via standard input, and the new | |
| tag name is expected on standard output. | |
| </p> | |
| <div class="paragraph"><p>The original tags are not deleted, but can be overwritten; | |
| use "--tag-name-filter cat" to simply update the tags. In this | |
| case, be very careful and make sure you have the old tags | |
| backed up in case the conversion has run afoul.</p></div> | |
| <div class="paragraph"><p>Nearly proper rewriting of tag objects is supported. If the tag has | |
| a message attached, a new tag object will be created with the same message, | |
| author, and timestamp. If the tag has a signature attached, the | |
| signature will be stripped. It is by definition impossible to preserve | |
| signatures. The reason this is "nearly" proper, is because ideally if | |
| the tag did not change (points to the same object, has the same name, etc.) | |
| it should retain any signature. That is not the case, signatures will always | |
| be removed, buyer beware. There is also no support for changing the | |
| author or timestamp (or the tag message for that matter). Tags which point | |
| to other tags will be rewritten to point to the underlying commit.</p></div> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --prune-empty | |
| </dt> | |
| <dd> | |
| <p> | |
| Some filters will generate empty commits that leave the tree untouched. | |
| This option instructs git-filter-branch to remove such commits if they | |
| have exactly one or zero non-pruned parents; merge commits will | |
| therefore remain intact. This option cannot be used together with | |
| <code>--commit-filter</code>, though the same effect can be achieved by using the | |
| provided <code>git_commit_non_empty_tree</code> function in a commit filter. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --original <namespace> | |
| </dt> | |
| <dd> | |
| <p> | |
| Use this option to set the namespace where the original commits | |
| will be stored. The default value is <em>refs/original</em>. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| -d <directory> | |
| </dt> | |
| <dd> | |
| <p> | |
| Use this option to set the path to the temporary directory used for | |
| rewriting. When applying a tree filter, the command needs to | |
| temporarily check out the tree to some directory, which may consume | |
| considerable space in case of large projects. By default it | |
| does this in the <em>.git-rewrite/</em> directory but you can override | |
| that choice by this parameter. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| -f | |
| </dt> | |
| <dt class="hdlist1"> | |
| --force | |
| </dt> | |
| <dd> | |
| <p> | |
| <em>git filter-branch</em> refuses to start with an existing temporary | |
| directory or when there are already refs starting with | |
| <em>refs/original/</em>, unless forced. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| --state-branch <branch> | |
| </dt> | |
| <dd> | |
| <p> | |
| This option will cause the mapping from old to new objects to | |
| be loaded from named branch upon startup and saved as a new | |
| commit to that branch upon exit, enabling incremental of large | |
| trees. If <em><branch></em> does not exist it will be created. | |
| </p> | |
| </dd> | |
| <dt class="hdlist1"> | |
| <rev-list options>… | |
| </dt> | |
| <dd> | |
| <p> | |
| Arguments for <em>git rev-list</em>. All positive refs included by | |
| these options are rewritten. You may also specify options | |
| such as <code>--all</code>, but you must use <code>--</code> to separate them from | |
| the <em>git filter-branch</em> options. Implies <a href="#Remap_to_ancestor">[Remap_to_ancestor]</a>. | |
| </p> | |
| </dd> | |
| </dl></div> | |
| <div class="sect2"> | |
| <h3 id="Remap_to_ancestor">Remap to ancestor</h3> | |
| <div class="paragraph"><p>By using <a href="git-rev-list.html">git-rev-list(1)</a> arguments, e.g., path limiters, you can limit the | |
| set of revisions which get rewritten. However, positive refs on the command | |
| line are distinguished: we don’t let them be excluded by such limiters. For | |
| this purpose, they are instead rewritten to point at the nearest ancestor that | |
| was not excluded.</p></div> | |
| </div> | |
| </div> | |
| </div> | |
| <div class="sect1"> | |
| <h2 id="_exit_status">EXIT STATUS</h2> | |
| <div class="sectionbody"> | |
| <div class="paragraph"><p>On success, the exit status is <code>0</code>. If the filter can’t find any commits to | |
| rewrite, the exit status is <code>2</code>. On any other error, the exit status may be | |
| any other non-zero value.</p></div> | |
| </div> | |
| </div> | |
| <div class="sect1"> | |
| <h2 id="_examples">EXAMPLES</h2> | |
| <div class="sectionbody"> | |
| <div class="paragraph"><p>Suppose you want to remove a file (containing confidential information | |
| or copyright violation) from all commits:</p></div> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre><code>git filter-branch --tree-filter 'rm filename' HEAD</code></pre> | |
| </div></div> | |
| <div class="paragraph"><p>However, if the file is absent from the tree of some commit, | |
| a simple <code>rm filename</code> will fail for that tree and commit. | |
| Thus you may instead want to use <code>rm -f filename</code> as the script.</p></div> | |
| <div class="paragraph"><p>Using <code>--index-filter</code> with <em>git rm</em> yields a significantly faster | |
| version. Like with using <code>rm filename</code>, <code>git rm --cached filename</code> | |
| will fail if the file is absent from the tree of a commit. If you | |
| want to "completely forget" a file, it does not matter when it entered | |
| history, so we also add <code>--ignore-unmatch</code>:</p></div> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre><code>git filter-branch --index-filter 'git rm --cached --ignore-unmatch filename' HEAD</code></pre> | |
| </div></div> | |
| <div class="paragraph"><p>Now, you will get the rewritten history saved in HEAD.</p></div> | |
| <div class="paragraph"><p>To rewrite the repository to look as if <code>foodir/</code> had been its project | |
| root, and discard all other history:</p></div> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre><code>git filter-branch --subdirectory-filter foodir -- --all</code></pre> | |
| </div></div> | |
| <div class="paragraph"><p>Thus you can, e.g., turn a library subdirectory into a repository of | |
| its own. Note the <code>--</code> that separates <em>filter-branch</em> options from | |
| revision options, and the <code>--all</code> to rewrite all branches and tags.</p></div> | |
| <div class="paragraph"><p>To set a commit (which typically is at the tip of another | |
| history) to be the parent of the current initial commit, in | |
| order to paste the other history behind the current history:</p></div> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre><code>git filter-branch --parent-filter 'sed "s/^\$/-p <graft-id>/"' HEAD</code></pre> | |
| </div></div> | |
| <div class="paragraph"><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> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre><code>git filter-branch --parent-filter \ | |
| 'test $GIT_COMMIT = <commit-id> && echo "-p <graft-id>" || cat' HEAD</code></pre> | |
| </div></div> | |
| <div class="paragraph"><p>or even simpler:</p></div> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre><code>git replace --graft $commit-id $graft-id | |
| git filter-branch $graft-id..HEAD</code></pre> | |
| </div></div> | |
| <div class="paragraph"><p>To remove commits authored by "Darl McBribe" from the history:</p></div> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre><code>git filter-branch --commit-filter ' | |
| if [ "$GIT_AUTHOR_NAME" = "Darl McBribe" ]; | |
| then | |
| skip_commit "$@"; | |
| else | |
| git commit-tree "$@"; | |
| fi' HEAD</code></pre> | |
| </div></div> | |
| <div class="paragraph"><p>The function <em>skip_commit</em> is defined as follows:</p></div> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre><code>skip_commit() | |
| { | |
| shift; | |
| while [ -n "$1" ]; | |
| do | |
| shift; | |
| map "$1"; | |
| shift; | |
| done; | |
| }</code></pre> | |
| </div></div> | |
| <div class="paragraph"><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 | |
| and all children of the merge will become merge commits with P1,P2 | |
| as their parents instead of the merge commit.</p></div> | |
| <div class="paragraph"><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 <em>changes</em> together with the commits, you should use the | |
| interactive mode of <em>git rebase</em>.</p></div> | |
| <div class="paragraph"><p>You can rewrite the commit log messages using <code>--msg-filter</code>. For | |
| example, <em>git svn-id</em> strings in a repository created by <em>git svn</em> can | |
| be removed this way:</p></div> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre><code>git filter-branch --msg-filter ' | |
| sed -e "/^git-svn-id:/d" | |
| '</code></pre> | |
| </div></div> | |
| <div class="paragraph"><p>If you need to add <em>Acked-by</em> lines to, say, the last 10 commits (none | |
| of which is a merge), use this command:</p></div> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre><code>git filter-branch --msg-filter ' | |
| cat && | |
| echo "Acked-by: Bugs Bunny <bunny@bugzilla.org>" | |
| ' HEAD~10..HEAD</code></pre> | |
| </div></div> | |
| <div class="paragraph"><p>The <code>--env-filter</code> option can be used to modify committer and/or author | |
| identity. For example, if you found out that your commits have the wrong | |
| identity due to a misconfigured user.email, you can make a correction, | |
| before publishing the project, like this:</p></div> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre><code>git filter-branch --env-filter ' | |
| if test "$GIT_AUTHOR_EMAIL" = "root@localhost" | |
| then | |
| GIT_AUTHOR_EMAIL=john@example.com | |
| fi | |
| if test "$GIT_COMMITTER_EMAIL" = "root@localhost" | |
| then | |
| GIT_COMMITTER_EMAIL=john@example.com | |
| fi | |
| ' -- --all</code></pre> | |
| </div></div> | |
| <div class="paragraph"><p>To restrict rewriting to only part of the history, specify a revision | |
| 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></div> | |
| <div class="paragraph"><p>Consider this history:</p></div> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre><code> D--E--F--G--H | |
| / / | |
| A--B-----C</code></pre> | |
| </div></div> | |
| <div class="paragraph"><p>To rewrite only commits D,E,F,G,H, but leave A, B and C alone, use:</p></div> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre><code>git filter-branch ... C..H</code></pre> | |
| </div></div> | |
| <div class="paragraph"><p>To rewrite commits E,F,G,H, use one of these:</p></div> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre><code>git filter-branch ... C..H --not D | |
| git filter-branch ... D..H --not C</code></pre> | |
| </div></div> | |
| <div class="paragraph"><p>To move the whole tree into a subdirectory, or remove it from there:</p></div> | |
| <div class="listingblock"> | |
| <div class="content"> | |
| <pre><code>git filter-branch --index-filter \ | |
| 'git ls-files -s | sed "s-\t\"*-&newsubdir/-" | | |
| GIT_INDEX_FILE=$GIT_INDEX_FILE.new \ | |
| git update-index --index-info && | |
| mv "$GIT_INDEX_FILE.new" "$GIT_INDEX_FILE"' HEAD</code></pre> | |
| </div></div> | |
| </div> | |
| </div> | |
| <div class="sect1"> | |
| <h2 id="_checklist_for_shrinking_a_repository">CHECKLIST FOR SHRINKING A REPOSITORY</h2> | |
| <div class="sectionbody"> | |
| <div class="paragraph"><p>git-filter-branch can be used to get rid of a subset of files, | |
| usually with some combination of <code>--index-filter</code> and | |
| <code>--subdirectory-filter</code>. People expect the resulting repository to | |
| be smaller than the original, but you need a few more steps to | |
| actually make it smaller, because Git tries hard not to lose your | |
| objects until you tell it to. First make sure that:</p></div> | |
| <div class="ulist"><ul> | |
| <li> | |
| <p> | |
| You really removed all variants of a filename, if a blob was moved | |
| over its lifetime. <code>git log --name-only --follow --all -- filename</code> | |
| can help you find renames. | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| You really filtered all refs: use <code>--tag-name-filter cat -- --all</code> | |
| when calling git-filter-branch. | |
| </p> | |
| </li> | |
| </ul></div> | |
| <div class="paragraph"><p>Then there are two ways to get a smaller repository. A safer way is | |
| to clone, that keeps your original intact.</p></div> | |
| <div class="ulist"><ul> | |
| <li> | |
| <p> | |
| Clone it with <code>git clone file:///path/to/repo</code>. The clone | |
| will not have the removed objects. See <a href="git-clone.html">git-clone(1)</a>. (Note | |
| that cloning with a plain path just hardlinks everything!) | |
| </p> | |
| </li> | |
| </ul></div> | |
| <div class="paragraph"><p>If you really don’t want to clone it, for whatever reasons, check the | |
| following points instead (in this order). This is a very destructive | |
| approach, so <strong>make a backup</strong> or go back to cloning it. You have been | |
| warned.</p></div> | |
| <div class="ulist"><ul> | |
| <li> | |
| <p> | |
| Remove the original refs backed up by git-filter-branch: say <code>git | |
| for-each-ref --format="%(refname)" refs/original/ | xargs -n 1 git | |
| update-ref -d</code>. | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| Expire all reflogs with <code>git reflog expire --expire=now --all</code>. | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| Garbage collect all unreferenced objects with <code>git gc --prune=now</code> | |
| (or if your git-gc is not new enough to support arguments to | |
| <code>--prune</code>, use <code>git repack -ad; git prune</code> instead). | |
| </p> | |
| </li> | |
| </ul></div> | |
| </div> | |
| </div> | |
| <div class="sect1"> | |
| <h2 id="_notes">NOTES</h2> | |
| <div class="sectionbody"> | |
| <div class="paragraph"><p>git-filter-branch allows you to make complex shell-scripted rewrites | |
| of your Git history, but you probably don’t need this flexibility if | |
| you’re simply <em>removing unwanted data</em> like large files or passwords. | |
| For those operations you may want to consider | |
| <a href="http://rtyley.github.io/bfg-repo-cleaner/">The BFG Repo-Cleaner</a>, | |
| a JVM-based alternative to git-filter-branch, typically at least | |
| 10-50x faster for those use-cases, and with quite different | |
| characteristics:</p></div> | |
| <div class="ulist"><ul> | |
| <li> | |
| <p> | |
| Any particular version of a file is cleaned exactly <em>once</em>. The BFG, | |
| unlike git-filter-branch, does not give you the opportunity to | |
| handle a file differently based on where or when it was committed | |
| within your history. This constraint gives the core performance | |
| benefit of The BFG, and is well-suited to the task of cleansing bad | |
| data - you don’t care <em>where</em> the bad data is, you just want it | |
| <em>gone</em>. | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| By default The BFG takes full advantage of multi-core machines, | |
| cleansing commit file-trees in parallel. git-filter-branch cleans | |
| commits sequentially (i.e. in a single-threaded manner), though it | |
| <em>is</em> possible to write filters that include their own parallelism, | |
| in the scripts executed against each commit. | |
| </p> | |
| </li> | |
| <li> | |
| <p> | |
| The <a href="http://rtyley.github.io/bfg-repo-cleaner/#examples">command options</a> | |
| are much more restrictive than git-filter branch, and dedicated just | |
| to the tasks of removing unwanted data- e.g: | |
| <code>--strip-blobs-bigger-than 1M</code>. | |
| </p> | |
| </li> | |
| </ul></div> | |
| </div> | |
| </div> | |
| <div class="sect1"> | |
| <h2 id="_git">GIT</h2> | |
| <div class="sectionbody"> | |
| <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div> | |
| </div> | |
| </div> | |
| </div> | |
| <div id="footnotes"><hr /></div> | |
| <div id="footer"> | |
| <div id="footer-text"> | |
| Last updated | |
| 2018-05-23 16:06:29 JST | |
| </div> | |
| </div> | |
| </body> | |
| </html> |