Autogenerated HTML docs for v2.45.1-204-gd8ab1
[git-htmldocs.git] / git-fast-export.html
blobf5af0f46f5b6285735ccb4248dc484afa96a40a7
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
3 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
5 <head>
6 <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
7 <meta name="generator" content="AsciiDoc 10.2.0" />
8 <title>git-fast-export(1)</title>
9 <style type="text/css">
10 /* Shared CSS for AsciiDoc xhtml11 and html5 backends */
12 /* Default font. */
13 body {
14 font-family: Georgia,serif;
17 /* Title font. */
18 h1, h2, h3, h4, h5, h6,
19 div.title, caption.title,
20 thead, p.table.header,
21 #toctitle,
22 #author, #revnumber, #revdate, #revremark,
23 #footer {
24 font-family: Arial,Helvetica,sans-serif;
27 body {
28 margin: 1em 5% 1em 5%;
31 a {
32 color: blue;
33 text-decoration: underline;
35 a:visited {
36 color: fuchsia;
39 em {
40 font-style: italic;
41 color: navy;
44 strong {
45 font-weight: bold;
46 color: #083194;
49 h1, h2, h3, h4, h5, h6 {
50 color: #527bbd;
51 margin-top: 1.2em;
52 margin-bottom: 0.5em;
53 line-height: 1.3;
56 h1, h2, h3 {
57 border-bottom: 2px solid silver;
59 h2 {
60 padding-top: 0.5em;
62 h3 {
63 float: left;
65 h3 + * {
66 clear: left;
68 h5 {
69 font-size: 1.0em;
72 div.sectionbody {
73 margin-left: 0;
76 hr {
77 border: 1px solid silver;
80 p {
81 margin-top: 0.5em;
82 margin-bottom: 0.5em;
85 ul, ol, li > p {
86 margin-top: 0;
88 ul > li { color: #aaa; }
89 ul > li > * { color: black; }
91 .monospaced, code, pre {
92 font-family: "Courier New", Courier, monospace;
93 font-size: inherit;
94 color: navy;
95 padding: 0;
96 margin: 0;
98 pre {
99 white-space: pre-wrap;
102 #author {
103 color: #527bbd;
104 font-weight: bold;
105 font-size: 1.1em;
107 #email {
109 #revnumber, #revdate, #revremark {
112 #footer {
113 font-size: small;
114 border-top: 2px solid silver;
115 padding-top: 0.5em;
116 margin-top: 4.0em;
118 #footer-text {
119 float: left;
120 padding-bottom: 0.5em;
122 #footer-badges {
123 float: right;
124 padding-bottom: 0.5em;
127 #preamble {
128 margin-top: 1.5em;
129 margin-bottom: 1.5em;
131 div.imageblock, div.exampleblock, div.verseblock,
132 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
133 div.admonitionblock {
134 margin-top: 1.0em;
135 margin-bottom: 1.5em;
137 div.admonitionblock {
138 margin-top: 2.0em;
139 margin-bottom: 2.0em;
140 margin-right: 10%;
141 color: #606060;
144 div.content { /* Block element content. */
145 padding: 0;
148 /* Block element titles. */
149 div.title, caption.title {
150 color: #527bbd;
151 font-weight: bold;
152 text-align: left;
153 margin-top: 1.0em;
154 margin-bottom: 0.5em;
156 div.title + * {
157 margin-top: 0;
160 td div.title:first-child {
161 margin-top: 0.0em;
163 div.content div.title:first-child {
164 margin-top: 0.0em;
166 div.content + div.title {
167 margin-top: 0.0em;
170 div.sidebarblock > div.content {
171 background: #ffffee;
172 border: 1px solid #dddddd;
173 border-left: 4px solid #f0f0f0;
174 padding: 0.5em;
177 div.listingblock > div.content {
178 border: 1px solid #dddddd;
179 border-left: 5px solid #f0f0f0;
180 background: #f8f8f8;
181 padding: 0.5em;
184 div.quoteblock, div.verseblock {
185 padding-left: 1.0em;
186 margin-left: 1.0em;
187 margin-right: 10%;
188 border-left: 5px solid #f0f0f0;
189 color: #888;
192 div.quoteblock > div.attribution {
193 padding-top: 0.5em;
194 text-align: right;
197 div.verseblock > pre.content {
198 font-family: inherit;
199 font-size: inherit;
201 div.verseblock > div.attribution {
202 padding-top: 0.75em;
203 text-align: left;
205 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
206 div.verseblock + div.attribution {
207 text-align: left;
210 div.admonitionblock .icon {
211 vertical-align: top;
212 font-size: 1.1em;
213 font-weight: bold;
214 text-decoration: underline;
215 color: #527bbd;
216 padding-right: 0.5em;
218 div.admonitionblock td.content {
219 padding-left: 0.5em;
220 border-left: 3px solid #dddddd;
223 div.exampleblock > div.content {
224 border-left: 3px solid #dddddd;
225 padding-left: 0.5em;
228 div.imageblock div.content { padding-left: 0; }
229 span.image img { border-style: none; vertical-align: text-bottom; }
230 a.image:visited { color: white; }
232 dl {
233 margin-top: 0.8em;
234 margin-bottom: 0.8em;
236 dt {
237 margin-top: 0.5em;
238 margin-bottom: 0;
239 font-style: normal;
240 color: navy;
242 dd > *:first-child {
243 margin-top: 0.1em;
246 ul, ol {
247 list-style-position: outside;
249 ol.arabic {
250 list-style-type: decimal;
252 ol.loweralpha {
253 list-style-type: lower-alpha;
255 ol.upperalpha {
256 list-style-type: upper-alpha;
258 ol.lowerroman {
259 list-style-type: lower-roman;
261 ol.upperroman {
262 list-style-type: upper-roman;
265 div.compact ul, div.compact ol,
266 div.compact p, div.compact p,
267 div.compact div, div.compact div {
268 margin-top: 0.1em;
269 margin-bottom: 0.1em;
272 tfoot {
273 font-weight: bold;
275 td > div.verse {
276 white-space: pre;
279 div.hdlist {
280 margin-top: 0.8em;
281 margin-bottom: 0.8em;
283 div.hdlist tr {
284 padding-bottom: 15px;
286 dt.hdlist1.strong, td.hdlist1.strong {
287 font-weight: bold;
289 td.hdlist1 {
290 vertical-align: top;
291 font-style: normal;
292 padding-right: 0.8em;
293 color: navy;
295 td.hdlist2 {
296 vertical-align: top;
298 div.hdlist.compact tr {
299 margin: 0;
300 padding-bottom: 0;
303 .comment {
304 background: yellow;
307 .footnote, .footnoteref {
308 font-size: 0.8em;
311 span.footnote, span.footnoteref {
312 vertical-align: super;
315 #footnotes {
316 margin: 20px 0 20px 0;
317 padding: 7px 0 0 0;
320 #footnotes div.footnote {
321 margin: 0 0 5px 0;
324 #footnotes hr {
325 border: none;
326 border-top: 1px solid silver;
327 height: 1px;
328 text-align: left;
329 margin-left: 0;
330 width: 20%;
331 min-width: 100px;
334 div.colist td {
335 padding-right: 0.5em;
336 padding-bottom: 0.3em;
337 vertical-align: top;
339 div.colist td img {
340 margin-top: 0.3em;
343 @media print {
344 #footer-badges { display: none; }
347 #toc {
348 margin-bottom: 2.5em;
351 #toctitle {
352 color: #527bbd;
353 font-size: 1.1em;
354 font-weight: bold;
355 margin-top: 1.0em;
356 margin-bottom: 0.1em;
359 div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
360 margin-top: 0;
361 margin-bottom: 0;
363 div.toclevel2 {
364 margin-left: 2em;
365 font-size: 0.9em;
367 div.toclevel3 {
368 margin-left: 4em;
369 font-size: 0.9em;
371 div.toclevel4 {
372 margin-left: 6em;
373 font-size: 0.9em;
376 span.aqua { color: aqua; }
377 span.black { color: black; }
378 span.blue { color: blue; }
379 span.fuchsia { color: fuchsia; }
380 span.gray { color: gray; }
381 span.green { color: green; }
382 span.lime { color: lime; }
383 span.maroon { color: maroon; }
384 span.navy { color: navy; }
385 span.olive { color: olive; }
386 span.purple { color: purple; }
387 span.red { color: red; }
388 span.silver { color: silver; }
389 span.teal { color: teal; }
390 span.white { color: white; }
391 span.yellow { color: yellow; }
393 span.aqua-background { background: aqua; }
394 span.black-background { background: black; }
395 span.blue-background { background: blue; }
396 span.fuchsia-background { background: fuchsia; }
397 span.gray-background { background: gray; }
398 span.green-background { background: green; }
399 span.lime-background { background: lime; }
400 span.maroon-background { background: maroon; }
401 span.navy-background { background: navy; }
402 span.olive-background { background: olive; }
403 span.purple-background { background: purple; }
404 span.red-background { background: red; }
405 span.silver-background { background: silver; }
406 span.teal-background { background: teal; }
407 span.white-background { background: white; }
408 span.yellow-background { background: yellow; }
410 span.big { font-size: 2em; }
411 span.small { font-size: 0.6em; }
413 span.underline { text-decoration: underline; }
414 span.overline { text-decoration: overline; }
415 span.line-through { text-decoration: line-through; }
417 div.unbreakable { page-break-inside: avoid; }
421 * xhtml11 specific
423 * */
425 div.tableblock {
426 margin-top: 1.0em;
427 margin-bottom: 1.5em;
429 div.tableblock > table {
430 border: 3px solid #527bbd;
432 thead, p.table.header {
433 font-weight: bold;
434 color: #527bbd;
436 p.table {
437 margin-top: 0;
439 /* Because the table frame attribute is overridden by CSS in most browsers. */
440 div.tableblock > table[frame="void"] {
441 border-style: none;
443 div.tableblock > table[frame="hsides"] {
444 border-left-style: none;
445 border-right-style: none;
447 div.tableblock > table[frame="vsides"] {
448 border-top-style: none;
449 border-bottom-style: none;
454 * html5 specific
456 * */
458 table.tableblock {
459 margin-top: 1.0em;
460 margin-bottom: 1.5em;
462 thead, p.tableblock.header {
463 font-weight: bold;
464 color: #527bbd;
466 p.tableblock {
467 margin-top: 0;
469 table.tableblock {
470 border-width: 3px;
471 border-spacing: 0px;
472 border-style: solid;
473 border-color: #527bbd;
474 border-collapse: collapse;
476 th.tableblock, td.tableblock {
477 border-width: 1px;
478 padding: 4px;
479 border-style: solid;
480 border-color: #527bbd;
483 table.tableblock.frame-topbot {
484 border-left-style: hidden;
485 border-right-style: hidden;
487 table.tableblock.frame-sides {
488 border-top-style: hidden;
489 border-bottom-style: hidden;
491 table.tableblock.frame-none {
492 border-style: hidden;
495 th.tableblock.halign-left, td.tableblock.halign-left {
496 text-align: left;
498 th.tableblock.halign-center, td.tableblock.halign-center {
499 text-align: center;
501 th.tableblock.halign-right, td.tableblock.halign-right {
502 text-align: right;
505 th.tableblock.valign-top, td.tableblock.valign-top {
506 vertical-align: top;
508 th.tableblock.valign-middle, td.tableblock.valign-middle {
509 vertical-align: middle;
511 th.tableblock.valign-bottom, td.tableblock.valign-bottom {
512 vertical-align: bottom;
517 * manpage specific
519 * */
521 body.manpage h1 {
522 padding-top: 0.5em;
523 padding-bottom: 0.5em;
524 border-top: 2px solid silver;
525 border-bottom: 2px solid silver;
527 body.manpage h2 {
528 border-style: none;
530 body.manpage div.sectionbody {
531 margin-left: 3em;
534 @media print {
535 body.manpage div#toc { display: none; }
539 </style>
540 <script type="text/javascript">
541 /*<![CDATA[*/
542 var asciidoc = { // Namespace.
544 /////////////////////////////////////////////////////////////////////
545 // Table Of Contents generator
546 /////////////////////////////////////////////////////////////////////
548 /* Author: Mihai Bazon, September 2002
549 * http://students.infoiasi.ro/~mishoo
551 * Table Of Content generator
552 * Version: 0.4
554 * Feel free to use this script under the terms of the GNU General Public
555 * License, as long as you do not remove or alter this notice.
558 /* modified by Troy D. Hanson, September 2006. License: GPL */
559 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
561 // toclevels = 1..4.
562 toc: function (toclevels) {
564 function getText(el) {
565 var text = "";
566 for (var i = el.firstChild; i != null; i = i.nextSibling) {
567 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
568 text += i.data;
569 else if (i.firstChild != null)
570 text += getText(i);
572 return text;
575 function TocEntry(el, text, toclevel) {
576 this.element = el;
577 this.text = text;
578 this.toclevel = toclevel;
581 function tocEntries(el, toclevels) {
582 var result = new Array;
583 var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
584 // Function that scans the DOM tree for header elements (the DOM2
585 // nodeIterator API would be a better technique but not supported by all
586 // browsers).
587 var iterate = function (el) {
588 for (var i = el.firstChild; i != null; i = i.nextSibling) {
589 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
590 var mo = re.exec(i.tagName);
591 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
592 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
594 iterate(i);
598 iterate(el);
599 return result;
602 var toc = document.getElementById("toc");
603 if (!toc) {
604 return;
607 // Delete existing TOC entries in case we're reloading the TOC.
608 var tocEntriesToRemove = [];
609 var i;
610 for (i = 0; i < toc.childNodes.length; i++) {
611 var entry = toc.childNodes[i];
612 if (entry.nodeName.toLowerCase() == 'div'
613 && entry.getAttribute("class")
614 && entry.getAttribute("class").match(/^toclevel/))
615 tocEntriesToRemove.push(entry);
617 for (i = 0; i < tocEntriesToRemove.length; i++) {
618 toc.removeChild(tocEntriesToRemove[i]);
621 // Rebuild TOC entries.
622 var entries = tocEntries(document.getElementById("content"), toclevels);
623 for (var i = 0; i < entries.length; ++i) {
624 var entry = entries[i];
625 if (entry.element.id == "")
626 entry.element.id = "_toc_" + i;
627 var a = document.createElement("a");
628 a.href = "#" + entry.element.id;
629 a.appendChild(document.createTextNode(entry.text));
630 var div = document.createElement("div");
631 div.appendChild(a);
632 div.className = "toclevel" + entry.toclevel;
633 toc.appendChild(div);
635 if (entries.length == 0)
636 toc.parentNode.removeChild(toc);
640 /////////////////////////////////////////////////////////////////////
641 // Footnotes generator
642 /////////////////////////////////////////////////////////////////////
644 /* Based on footnote generation code from:
645 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
648 footnotes: function () {
649 // Delete existing footnote entries in case we're reloading the footnodes.
650 var i;
651 var noteholder = document.getElementById("footnotes");
652 if (!noteholder) {
653 return;
655 var entriesToRemove = [];
656 for (i = 0; i < noteholder.childNodes.length; i++) {
657 var entry = noteholder.childNodes[i];
658 if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
659 entriesToRemove.push(entry);
661 for (i = 0; i < entriesToRemove.length; i++) {
662 noteholder.removeChild(entriesToRemove[i]);
665 // Rebuild footnote entries.
666 var cont = document.getElementById("content");
667 var spans = cont.getElementsByTagName("span");
668 var refs = {};
669 var n = 0;
670 for (i=0; i<spans.length; i++) {
671 if (spans[i].className == "footnote") {
672 n++;
673 var note = spans[i].getAttribute("data-note");
674 if (!note) {
675 // Use [\s\S] in place of . so multi-line matches work.
676 // Because JavaScript has no s (dotall) regex flag.
677 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
678 spans[i].innerHTML =
679 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
680 "' title='View footnote' class='footnote'>" + n + "</a>]";
681 spans[i].setAttribute("data-note", note);
683 noteholder.innerHTML +=
684 "<div class='footnote' id='_footnote_" + n + "'>" +
685 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
686 n + "</a>. " + note + "</div>";
687 var id =spans[i].getAttribute("id");
688 if (id != null) refs["#"+id] = n;
691 if (n == 0)
692 noteholder.parentNode.removeChild(noteholder);
693 else {
694 // Process footnoterefs.
695 for (i=0; i<spans.length; i++) {
696 if (spans[i].className == "footnoteref") {
697 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
698 href = href.match(/#.*/)[0]; // Because IE return full URL.
699 n = refs[href];
700 spans[i].innerHTML =
701 "[<a href='#_footnote_" + n +
702 "' title='View footnote' class='footnote'>" + n + "</a>]";
708 install: function(toclevels) {
709 var timerId;
711 function reinstall() {
712 asciidoc.footnotes();
713 if (toclevels) {
714 asciidoc.toc(toclevels);
718 function reinstallAndRemoveTimer() {
719 clearInterval(timerId);
720 reinstall();
723 timerId = setInterval(reinstall, 500);
724 if (document.addEventListener)
725 document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
726 else
727 window.onload = reinstallAndRemoveTimer;
731 asciidoc.install();
732 /*]]>*/
733 </script>
734 </head>
735 <body class="manpage">
736 <div id="header">
737 <h1>
738 git-fast-export(1) Manual Page
739 </h1>
740 <h2>NAME</h2>
741 <div class="sectionbody">
742 <p>git-fast-export -
743 Git data exporter
744 </p>
745 </div>
746 </div>
747 <div id="content">
748 <div class="sect1">
749 <h2 id="_synopsis">SYNOPSIS</h2>
750 <div class="sectionbody">
751 <div class="verseblock">
752 <pre class="content"><em>git fast-export</em> [&lt;options&gt;] | <em>git fast-import</em></pre>
753 <div class="attribution">
754 </div></div>
755 </div>
756 </div>
757 <div class="sect1">
758 <h2 id="_description">DESCRIPTION</h2>
759 <div class="sectionbody">
760 <div class="paragraph"><p>This program dumps the given revisions in a form suitable to be piped
761 into <em>git fast-import</em>.</p></div>
762 <div class="paragraph"><p>You can use it as a human-readable bundle replacement (see
763 <a href="git-bundle.html">git-bundle(1)</a>), or as a format that can be edited before being
764 fed to <em>git fast-import</em> in order to do history rewrites (an ability
765 relied on by tools like <em>git filter-repo</em>).</p></div>
766 </div>
767 </div>
768 <div class="sect1">
769 <h2 id="_options">OPTIONS</h2>
770 <div class="sectionbody">
771 <div class="dlist"><dl>
772 <dt class="hdlist1">
773 --progress=&lt;n&gt;
774 </dt>
775 <dd>
777 Insert <em>progress</em> statements every &lt;n&gt; objects, to be shown by
778 <em>git fast-import</em> during import.
779 </p>
780 </dd>
781 <dt class="hdlist1">
782 --signed-tags=(verbatim|warn|warn-strip|strip|abort)
783 </dt>
784 <dd>
786 Specify how to handle signed tags. Since any transformation
787 after the export can change the tag names (which can also happen
788 when excluding revisions) the signatures will not match.
789 </p>
790 <div class="paragraph"><p>When asking to <em>abort</em> (which is the default), this program will die
791 when encountering a signed tag. With <em>strip</em>, the tags will silently
792 be made unsigned, with <em>warn-strip</em> they will be made unsigned but a
793 warning will be displayed, with <em>verbatim</em>, they will be silently
794 exported and with <em>warn</em>, they will be exported, but you will see a
795 warning.</p></div>
796 </dd>
797 <dt class="hdlist1">
798 --tag-of-filtered-object=(abort|drop|rewrite)
799 </dt>
800 <dd>
802 Specify how to handle tags whose tagged object is filtered out.
803 Since revisions and files to export can be limited by path,
804 tagged objects may be filtered completely.
805 </p>
806 <div class="paragraph"><p>When asking to <em>abort</em> (which is the default), this program will die
807 when encountering such a tag. With <em>drop</em> it will omit such tags from
808 the output. With <em>rewrite</em>, if the tagged object is a commit, it will
809 rewrite the tag to tag an ancestor commit (via parent rewriting; see
810 <a href="git-rev-list.html">git-rev-list(1)</a>).</p></div>
811 </dd>
812 <dt class="hdlist1">
814 </dt>
815 <dt class="hdlist1">
817 </dt>
818 <dd>
820 Perform move and/or copy detection, as described in the
821 <a href="git-diff.html">git-diff(1)</a> manual page, and use it to generate
822 rename and copy commands in the output dump.
823 </p>
824 <div class="paragraph"><p>Note that earlier versions of this command did not complain and
825 produced incorrect results if you gave these options.</p></div>
826 </dd>
827 <dt class="hdlist1">
828 --export-marks=&lt;file&gt;
829 </dt>
830 <dd>
832 Dumps the internal marks table to &lt;file&gt; when complete.
833 Marks are written one per line as <code>:markid SHA-1</code>. Only marks
834 for revisions are dumped; marks for blobs are ignored.
835 Backends can use this file to validate imports after they
836 have been completed, or to save the marks table across
837 incremental runs. As &lt;file&gt; is only opened and truncated
838 at completion, the same path can also be safely given to
839 --import-marks.
840 The file will not be written if no new object has been
841 marked/exported.
842 </p>
843 </dd>
844 <dt class="hdlist1">
845 --import-marks=&lt;file&gt;
846 </dt>
847 <dd>
849 Before processing any input, load the marks specified in
850 &lt;file&gt;. The input file must exist, must be readable, and
851 must use the same format as produced by --export-marks.
852 </p>
853 </dd>
854 <dt class="hdlist1">
855 --mark-tags
856 </dt>
857 <dd>
859 In addition to labelling blobs and commits with mark ids, also
860 label tags. This is useful in conjunction with
861 <code>--export-marks</code> and <code>--import-marks</code>, and is also useful (and
862 necessary) for exporting of nested tags. It does not hurt
863 other cases and would be the default, but many fast-import
864 frontends are not prepared to accept tags with mark
865 identifiers.
866 </p>
867 <div class="paragraph"><p>Any commits (or tags) that have already been marked will not be
868 exported again. If the backend uses a similar --import-marks file,
869 this allows for incremental bidirectional exporting of the repository
870 by keeping the marks the same across runs.</p></div>
871 </dd>
872 <dt class="hdlist1">
873 --fake-missing-tagger
874 </dt>
875 <dd>
877 Some old repositories have tags without a tagger. The
878 fast-import protocol was pretty strict about that, and did not
879 allow that. So fake a tagger to be able to fast-import the
880 output.
881 </p>
882 </dd>
883 <dt class="hdlist1">
884 --use-done-feature
885 </dt>
886 <dd>
888 Start the stream with a <em>feature done</em> stanza, and terminate
889 it with a <em>done</em> command.
890 </p>
891 </dd>
892 <dt class="hdlist1">
893 --no-data
894 </dt>
895 <dd>
897 Skip output of blob objects and instead refer to blobs via
898 their original SHA-1 hash. This is useful when rewriting the
899 directory structure or history of a repository without
900 touching the contents of individual files. Note that the
901 resulting stream can only be used by a repository which
902 already contains the necessary objects.
903 </p>
904 </dd>
905 <dt class="hdlist1">
906 --full-tree
907 </dt>
908 <dd>
910 This option will cause fast-export to issue a "deleteall"
911 directive for each commit followed by a full list of all files
912 in the commit (as opposed to just listing the files which are
913 different from the commit&#8217;s first parent).
914 </p>
915 </dd>
916 <dt class="hdlist1">
917 --anonymize
918 </dt>
919 <dd>
921 Anonymize the contents of the repository while still retaining
922 the shape of the history and stored tree. See the section on
923 <code>ANONYMIZING</code> below.
924 </p>
925 </dd>
926 <dt class="hdlist1">
927 --anonymize-map=&lt;from&gt;[:&lt;to&gt;]
928 </dt>
929 <dd>
931 Convert token <code>&lt;from&gt;</code> to <code>&lt;to&gt;</code> in the anonymized output. If
932 <code>&lt;to&gt;</code> is omitted, map <code>&lt;from&gt;</code> to itself (i.e., do not
933 anonymize it). See the section on <code>ANONYMIZING</code> below.
934 </p>
935 </dd>
936 <dt class="hdlist1">
937 --reference-excluded-parents
938 </dt>
939 <dd>
941 By default, running a command such as <code>git fast-export
942 master~5..master</code> will not include the commit master&#126;5
943 and will make master&#126;4 no longer have master&#126;5 as
944 a parent (though both the old master&#126;4 and new
945 master&#126;4 will have all the same files). Use
946 --reference-excluded-parents to instead have the stream
947 refer to commits in the excluded range of history by their
948 sha1sum. Note that the resulting stream can only be used by a
949 repository which already contains the necessary parent
950 commits.
951 </p>
952 </dd>
953 <dt class="hdlist1">
954 --show-original-ids
955 </dt>
956 <dd>
958 Add an extra directive to the output for commits and blobs,
959 <code>original-oid &lt;SHA1SUM&gt;</code>. While such directives will likely be
960 ignored by importers such as git-fast-import, it may be useful
961 for intermediary filters (e.g. for rewriting commit messages
962 which refer to older commits, or for stripping blobs by id).
963 </p>
964 </dd>
965 <dt class="hdlist1">
966 --reencode=(yes|no|abort)
967 </dt>
968 <dd>
970 Specify how to handle <code>encoding</code> header in commit objects. When
971 asking to <em>abort</em> (which is the default), this program will die
972 when encountering such a commit object. With <em>yes</em>, the commit
973 message will be re-encoded into UTF-8. With <em>no</em>, the original
974 encoding will be preserved.
975 </p>
976 </dd>
977 <dt class="hdlist1">
978 --refspec
979 </dt>
980 <dd>
982 Apply the specified refspec to each ref exported. Multiple of them can
983 be specified.
984 </p>
985 </dd>
986 <dt class="hdlist1">
987 [&lt;git-rev-list-args&gt;&#8230;]
988 </dt>
989 <dd>
991 A list of arguments, acceptable to <em>git rev-parse</em> and
992 <em>git rev-list</em>, that specifies the specific objects and references
993 to export. For example, <code>master~10..master</code> causes the
994 current master reference to be exported along with all objects
995 added since its 10th ancestor commit and (unless the
996 --reference-excluded-parents option is specified) all files
997 common to master&#126;9 and master&#126;10.
998 </p>
999 </dd>
1000 </dl></div>
1001 </div>
1002 </div>
1003 <div class="sect1">
1004 <h2 id="_examples">EXAMPLES</h2>
1005 <div class="sectionbody">
1006 <div class="listingblock">
1007 <div class="content">
1008 <pre><code>$ git fast-export --all | (cd /empty/repository &amp;&amp; git fast-import)</code></pre>
1009 </div></div>
1010 <div class="paragraph"><p>This will export the whole repository and import it into the existing
1011 empty repository. Except for reencoding commits that are not in
1012 UTF-8, it would be a one-to-one mirror.</p></div>
1013 <div class="listingblock">
1014 <div class="content">
1015 <pre><code>$ git fast-export master~5..master |
1016 sed "s|refs/heads/master|refs/heads/other|" |
1017 git fast-import</code></pre>
1018 </div></div>
1019 <div class="paragraph"><p>This makes a new branch called <em>other</em> from <em>master~5..master</em>
1020 (i.e. if <em>master</em> has linear history, it will take the last 5 commits).</p></div>
1021 <div class="paragraph"><p>Note that this assumes that none of the blobs and commit messages
1022 referenced by that revision range contains the string
1023 <em>refs/heads/master</em>.</p></div>
1024 </div>
1025 </div>
1026 <div class="sect1">
1027 <h2 id="_anonymizing">ANONYMIZING</h2>
1028 <div class="sectionbody">
1029 <div class="paragraph"><p>If the <code>--anonymize</code> option is given, git will attempt to remove all
1030 identifying information from the repository while still retaining enough
1031 of the original tree and history patterns to reproduce some bugs. The
1032 goal is that a git bug which is found on a private repository will
1033 persist in the anonymized repository, and the latter can be shared with
1034 git developers to help solve the bug.</p></div>
1035 <div class="paragraph"><p>With this option, git will replace all refnames, paths, blob contents,
1036 commit and tag messages, names, and email addresses in the output with
1037 anonymized data. Two instances of the same string will be replaced
1038 equivalently (e.g., two commits with the same author will have the same
1039 anonymized author in the output, but bear no resemblance to the original
1040 author string). The relationship between commits, branches, and tags is
1041 retained, as well as the commit timestamps (but the commit messages and
1042 refnames bear no resemblance to the originals). The relative makeup of
1043 the tree is retained (e.g., if you have a root tree with 10 files and 3
1044 trees, so will the output), but their names and the contents of the
1045 files will be replaced.</p></div>
1046 <div class="paragraph"><p>If you think you have found a git bug, you can start by exporting an
1047 anonymized stream of the whole repository:</p></div>
1048 <div class="listingblock">
1049 <div class="content">
1050 <pre><code>$ git fast-export --anonymize --all &gt;anon-stream</code></pre>
1051 </div></div>
1052 <div class="paragraph"><p>Then confirm that the bug persists in a repository created from that
1053 stream (many bugs will not, as they really do depend on the exact
1054 repository contents):</p></div>
1055 <div class="listingblock">
1056 <div class="content">
1057 <pre><code>$ git init anon-repo
1058 $ cd anon-repo
1059 $ git fast-import &lt;../anon-stream
1060 $ ... test your bug ...</code></pre>
1061 </div></div>
1062 <div class="paragraph"><p>If the anonymized repository shows the bug, it may be worth sharing
1063 <code>anon-stream</code> along with a regular bug report. Note that the anonymized
1064 stream compresses very well, so gzipping it is encouraged. If you want
1065 to examine the stream to see that it does not contain any private data,
1066 you can peruse it directly before sending. You may also want to try:</p></div>
1067 <div class="listingblock">
1068 <div class="content">
1069 <pre><code>$ perl -pe 's/\d+/X/g' &lt;anon-stream | sort -u | less</code></pre>
1070 </div></div>
1071 <div class="paragraph"><p>which shows all of the unique lines (with numbers converted to "X", to
1072 collapse "User 0", "User 1", etc into "User X"). This produces a much
1073 smaller output, and it is usually easy to quickly confirm that there is
1074 no private data in the stream.</p></div>
1075 <div class="paragraph"><p>Reproducing some bugs may require referencing particular commits or
1076 paths, which becomes challenging after refnames and paths have been
1077 anonymized. You can ask for a particular token to be left as-is or
1078 mapped to a new value. For example, if you have a bug which reproduces
1079 with <code>git rev-list sensitive -- secret.c</code>, you can run:</p></div>
1080 <div class="listingblock">
1081 <div class="content">
1082 <pre><code>$ git fast-export --anonymize --all \
1083 --anonymize-map=sensitive:foo \
1084 --anonymize-map=secret.c:bar.c \
1085 &gt;stream</code></pre>
1086 </div></div>
1087 <div class="paragraph"><p>After importing the stream, you can then run <code>git rev-list foo -- bar.c</code>
1088 in the anonymized repository.</p></div>
1089 <div class="paragraph"><p>Note that paths and refnames are split into tokens at slash boundaries.
1090 The command above would anonymize <code>subdir/secret.c</code> as something like
1091 <code>path123/bar.c</code>; you could then search for <code>bar.c</code> in the anonymized
1092 repository to determine the final pathname.</p></div>
1093 <div class="paragraph"><p>To make referencing the final pathname simpler, you can map each path
1094 component; so if you also anonymize <code>subdir</code> to <code>publicdir</code>, then the
1095 final pathname would be <code>publicdir/bar.c</code>.</p></div>
1096 </div>
1097 </div>
1098 <div class="sect1">
1099 <h2 id="_limitations">LIMITATIONS</h2>
1100 <div class="sectionbody">
1101 <div class="paragraph"><p>Since <em>git fast-import</em> cannot tag trees, you will not be
1102 able to export the linux.git repository completely, as it contains
1103 a tag referencing a tree instead of a commit.</p></div>
1104 </div>
1105 </div>
1106 <div class="sect1">
1107 <h2 id="_see_also">SEE ALSO</h2>
1108 <div class="sectionbody">
1109 <div class="paragraph"><p><a href="git-fast-import.html">git-fast-import(1)</a></p></div>
1110 </div>
1111 </div>
1112 <div class="sect1">
1113 <h2 id="_git">GIT</h2>
1114 <div class="sectionbody">
1115 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
1116 </div>
1117 </div>
1118 </div>
1119 <div id="footnotes"><hr /></div>
1120 <div id="footer">
1121 <div id="footer-text">
1122 Last updated
1123 2024-03-01 17:30:58 PST
1124 </div>
1125 </div>
1126 </body>
1127 </html>