Autogenerated HTML docs for v1.7.7-325-g05f6ed
[git/jnareb-git.git] / git-fast-export.html
blob6832202778dbc970f7ca2efaf4a36e0390b2a95f
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
4 <head>
5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
6 <meta name="generator" content="AsciiDoc 8.5.2" />
7 <title>git-fast-export(1)</title>
8 <style type="text/css">
9 /* Debug borders */
10 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
12 border: 1px solid red;
16 body {
17 margin: 1em 5% 1em 5%;
20 a {
21 color: blue;
22 text-decoration: underline;
24 a:visited {
25 color: fuchsia;
28 em {
29 font-style: italic;
30 color: navy;
33 strong {
34 font-weight: bold;
35 color: #083194;
38 tt {
39 color: navy;
42 h1, h2, h3, h4, h5, h6 {
43 color: #527bbd;
44 font-family: sans-serif;
45 margin-top: 1.2em;
46 margin-bottom: 0.5em;
47 line-height: 1.3;
50 h1, h2, h3 {
51 border-bottom: 2px solid silver;
53 h2 {
54 padding-top: 0.5em;
56 h3 {
57 float: left;
59 h3 + * {
60 clear: left;
63 div.sectionbody {
64 font-family: serif;
65 margin-left: 0;
68 hr {
69 border: 1px solid silver;
72 p {
73 margin-top: 0.5em;
74 margin-bottom: 0.5em;
77 ul, ol, li > p {
78 margin-top: 0;
81 pre {
82 padding: 0;
83 margin: 0;
86 span#author {
87 color: #527bbd;
88 font-family: sans-serif;
89 font-weight: bold;
90 font-size: 1.1em;
92 span#email {
94 span#revnumber, span#revdate, span#revremark {
95 font-family: sans-serif;
98 div#footer {
99 font-family: sans-serif;
100 font-size: small;
101 border-top: 2px solid silver;
102 padding-top: 0.5em;
103 margin-top: 4.0em;
105 div#footer-text {
106 float: left;
107 padding-bottom: 0.5em;
109 div#footer-badges {
110 float: right;
111 padding-bottom: 0.5em;
114 div#preamble {
115 margin-top: 1.5em;
116 margin-bottom: 1.5em;
118 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
119 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
120 div.admonitionblock {
121 margin-top: 1.0em;
122 margin-bottom: 1.5em;
124 div.admonitionblock {
125 margin-top: 2.0em;
126 margin-bottom: 2.0em;
127 margin-right: 10%;
128 color: #606060;
131 div.content { /* Block element content. */
132 padding: 0;
135 /* Block element titles. */
136 div.title, caption.title {
137 color: #527bbd;
138 font-family: sans-serif;
139 font-weight: bold;
140 text-align: left;
141 margin-top: 1.0em;
142 margin-bottom: 0.5em;
144 div.title + * {
145 margin-top: 0;
148 td div.title:first-child {
149 margin-top: 0.0em;
151 div.content div.title:first-child {
152 margin-top: 0.0em;
154 div.content + div.title {
155 margin-top: 0.0em;
158 div.sidebarblock > div.content {
159 background: #ffffee;
160 border: 1px solid silver;
161 padding: 0.5em;
164 div.listingblock > div.content {
165 border: 1px solid silver;
166 background: #f4f4f4;
167 padding: 0.5em;
170 div.quoteblock, div.verseblock {
171 padding-left: 1.0em;
172 margin-left: 1.0em;
173 margin-right: 10%;
174 border-left: 5px solid #dddddd;
175 color: #777777;
178 div.quoteblock > div.attribution {
179 padding-top: 0.5em;
180 text-align: right;
183 div.verseblock > div.content {
184 white-space: pre;
186 div.verseblock > div.attribution {
187 padding-top: 0.75em;
188 text-align: left;
190 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
191 div.verseblock + div.attribution {
192 text-align: left;
195 div.admonitionblock .icon {
196 vertical-align: top;
197 font-size: 1.1em;
198 font-weight: bold;
199 text-decoration: underline;
200 color: #527bbd;
201 padding-right: 0.5em;
203 div.admonitionblock td.content {
204 padding-left: 0.5em;
205 border-left: 3px solid #dddddd;
208 div.exampleblock > div.content {
209 border-left: 3px solid #dddddd;
210 padding-left: 0.5em;
213 div.imageblock div.content { padding-left: 0; }
214 span.image img { border-style: none; }
215 a.image:visited { color: white; }
217 dl {
218 margin-top: 0.8em;
219 margin-bottom: 0.8em;
221 dt {
222 margin-top: 0.5em;
223 margin-bottom: 0;
224 font-style: normal;
225 color: navy;
227 dd > *:first-child {
228 margin-top: 0.1em;
231 ul, ol {
232 list-style-position: outside;
234 ol.arabic {
235 list-style-type: decimal;
237 ol.loweralpha {
238 list-style-type: lower-alpha;
240 ol.upperalpha {
241 list-style-type: upper-alpha;
243 ol.lowerroman {
244 list-style-type: lower-roman;
246 ol.upperroman {
247 list-style-type: upper-roman;
250 div.compact ul, div.compact ol,
251 div.compact p, div.compact p,
252 div.compact div, div.compact div {
253 margin-top: 0.1em;
254 margin-bottom: 0.1em;
257 div.tableblock > table {
258 border: 3px solid #527bbd;
260 thead, p.table.header {
261 font-family: sans-serif;
262 font-weight: bold;
264 tfoot {
265 font-weight: bold;
267 td > div.verse {
268 white-space: pre;
270 p.table {
271 margin-top: 0;
273 /* Because the table frame attribute is overriden by CSS in most browsers. */
274 div.tableblock > table[frame="void"] {
275 border-style: none;
277 div.tableblock > table[frame="hsides"] {
278 border-left-style: none;
279 border-right-style: none;
281 div.tableblock > table[frame="vsides"] {
282 border-top-style: none;
283 border-bottom-style: none;
287 div.hdlist {
288 margin-top: 0.8em;
289 margin-bottom: 0.8em;
291 div.hdlist tr {
292 padding-bottom: 15px;
294 dt.hdlist1.strong, td.hdlist1.strong {
295 font-weight: bold;
297 td.hdlist1 {
298 vertical-align: top;
299 font-style: normal;
300 padding-right: 0.8em;
301 color: navy;
303 td.hdlist2 {
304 vertical-align: top;
306 div.hdlist.compact tr {
307 margin: 0;
308 padding-bottom: 0;
311 .comment {
312 background: yellow;
315 .footnote, .footnoteref {
316 font-size: 0.8em;
319 span.footnote, span.footnoteref {
320 vertical-align: super;
323 #footnotes {
324 margin: 20px 0 20px 0;
325 padding: 7px 0 0 0;
328 #footnotes div.footnote {
329 margin: 0 0 5px 0;
332 #footnotes hr {
333 border: none;
334 border-top: 1px solid silver;
335 height: 1px;
336 text-align: left;
337 margin-left: 0;
338 width: 20%;
339 min-width: 100px;
343 @media print {
344 div#footer-badges { display: none; }
347 div#toc {
348 margin-bottom: 2.5em;
351 div#toctitle {
352 color: #527bbd;
353 font-family: sans-serif;
354 font-size: 1.1em;
355 font-weight: bold;
356 margin-top: 1.0em;
357 margin-bottom: 0.1em;
360 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
361 margin-top: 0;
362 margin-bottom: 0;
364 div.toclevel2 {
365 margin-left: 2em;
366 font-size: 0.9em;
368 div.toclevel3 {
369 margin-left: 4em;
370 font-size: 0.9em;
372 div.toclevel4 {
373 margin-left: 6em;
374 font-size: 0.9em;
376 /* Overrides for manpage documents */
377 h1 {
378 padding-top: 0.5em;
379 padding-bottom: 0.5em;
380 border-top: 2px solid silver;
381 border-bottom: 2px solid silver;
383 h2 {
384 border-style: none;
386 div.sectionbody {
387 margin-left: 5%;
390 @media print {
391 div#toc { display: none; }
394 /* Workarounds for IE6's broken and incomplete CSS2. */
396 div.sidebar-content {
397 background: #ffffee;
398 border: 1px solid silver;
399 padding: 0.5em;
401 div.sidebar-title, div.image-title {
402 color: #527bbd;
403 font-family: sans-serif;
404 font-weight: bold;
405 margin-top: 0.0em;
406 margin-bottom: 0.5em;
409 div.listingblock div.content {
410 border: 1px solid silver;
411 background: #f4f4f4;
412 padding: 0.5em;
415 div.quoteblock-attribution {
416 padding-top: 0.5em;
417 text-align: right;
420 div.verseblock-content {
421 white-space: pre;
423 div.verseblock-attribution {
424 padding-top: 0.75em;
425 text-align: left;
428 div.exampleblock-content {
429 border-left: 3px solid #dddddd;
430 padding-left: 0.5em;
433 /* IE6 sets dynamically generated links as visited. */
434 div#toc a:visited { color: blue; }
435 </style>
436 <script type="text/javascript">
437 /*<![CDATA[*/
438 window.onload = function(){asciidoc.footnotes();}
439 var asciidoc = { // Namespace.
441 /////////////////////////////////////////////////////////////////////
442 // Table Of Contents generator
443 /////////////////////////////////////////////////////////////////////
445 /* Author: Mihai Bazon, September 2002
446 * http://students.infoiasi.ro/~mishoo
448 * Table Of Content generator
449 * Version: 0.4
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.
455 /* modified by Troy D. Hanson, September 2006. License: GPL */
456 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
458 // toclevels = 1..4.
459 toc: function (toclevels) {
461 function getText(el) {
462 var text = "";
463 for (var i = el.firstChild; i != null; i = i.nextSibling) {
464 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
465 text += i.data;
466 else if (i.firstChild != null)
467 text += getText(i);
469 return text;
472 function TocEntry(el, text, toclevel) {
473 this.element = el;
474 this.text = text;
475 this.toclevel = toclevel;
478 function tocEntries(el, toclevels) {
479 var result = new Array;
480 var re = new RegExp('[hH]([2-'+(toclevels+1)+'])');
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).
484 var iterate = function (el) {
485 for (var i = el.firstChild; i != null; i = i.nextSibling) {
486 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
487 var mo = re.exec(i.tagName);
488 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
489 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
491 iterate(i);
495 iterate(el);
496 return result;
499 var toc = document.getElementById("toc");
500 var entries = tocEntries(document.getElementById("content"), toclevels);
501 for (var i = 0; i < entries.length; ++i) {
502 var entry = entries[i];
503 if (entry.element.id == "")
504 entry.element.id = "_toc_" + i;
505 var a = document.createElement("a");
506 a.href = "#" + entry.element.id;
507 a.appendChild(document.createTextNode(entry.text));
508 var div = document.createElement("div");
509 div.appendChild(a);
510 div.className = "toclevel" + entry.toclevel;
511 toc.appendChild(div);
513 if (entries.length == 0)
514 toc.parentNode.removeChild(toc);
518 /////////////////////////////////////////////////////////////////////
519 // Footnotes generator
520 /////////////////////////////////////////////////////////////////////
522 /* Based on footnote generation code from:
523 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
526 footnotes: function () {
527 var cont = document.getElementById("content");
528 var noteholder = document.getElementById("footnotes");
529 var spans = cont.getElementsByTagName("span");
530 var refs = {};
531 var n = 0;
532 for (i=0; i<spans.length; i++) {
533 if (spans[i].className == "footnote") {
534 n++;
535 // Use [\s\S] in place of . so multi-line matches work.
536 // Because JavaScript has no s (dotall) regex flag.
537 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
538 noteholder.innerHTML +=
539 "<div class='footnote' id='_footnote_" + n + "'>" +
540 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
541 n + "</a>. " + note + "</div>";
542 spans[i].innerHTML =
543 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
544 "' title='View footnote' class='footnote'>" + n + "</a>]";
545 var id =spans[i].getAttribute("id");
546 if (id != null) refs["#"+id] = n;
549 if (n == 0)
550 noteholder.parentNode.removeChild(noteholder);
551 else {
552 // Process footnoterefs.
553 for (i=0; i<spans.length; i++) {
554 if (spans[i].className == "footnoteref") {
555 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
556 href = href.match(/#.*/)[0]; // Because IE return full URL.
557 n = refs[href];
558 spans[i].innerHTML =
559 "[<a href='#_footnote_" + n +
560 "' title='View footnote' class='footnote'>" + n + "</a>]";
567 /*]]>*/
568 </script>
569 </head>
570 <body>
571 <div id="header">
572 <h1>
573 git-fast-export(1) Manual Page
574 </h1>
575 <h2>NAME</h2>
576 <div class="sectionbody">
577 <p>git-fast-export -
578 Git data exporter
579 </p>
580 </div>
581 </div>
582 <div id="content">
583 <h2 id="_synopsis">SYNOPSIS</h2>
584 <div class="sectionbody">
585 <div class="verseblock">
586 <div class="verseblock-content"><em>git fast-export [options]</em> | <em>git fast-import</em></div>
587 <div class="verseblock-attribution">
588 </div></div>
589 </div>
590 <h2 id="_description">DESCRIPTION</h2>
591 <div class="sectionbody">
592 <div class="paragraph"><p>This program dumps the given revisions in a form suitable to be piped
593 into <em>git fast-import</em>.</p></div>
594 <div class="paragraph"><p>You can use it as a human-readable bundle replacement (see
595 <a href="git-bundle.html">git-bundle(1)</a>), or as a kind of an interactive
596 <em>git filter-branch</em>.</p></div>
597 </div>
598 <h2 id="_options">OPTIONS</h2>
599 <div class="sectionbody">
600 <div class="dlist"><dl>
601 <dt class="hdlist1">
602 --progress=&lt;n&gt;
603 </dt>
604 <dd>
606 Insert <em>progress</em> statements every &lt;n&gt; objects, to be shown by
607 <em>git fast-import</em> during import.
608 </p>
609 </dd>
610 <dt class="hdlist1">
611 --signed-tags=(verbatim|warn|strip|abort)
612 </dt>
613 <dd>
615 Specify how to handle signed tags. Since any transformation
616 after the export can change the tag names (which can also happen
617 when excluding revisions) the signatures will not match.
618 </p>
619 <div class="paragraph"><p>When asking to <em>abort</em> (which is the default), this program will die
620 when encountering a signed tag. With <em>strip</em>, the tags will be made
621 unsigned, with <em>verbatim</em>, they will be silently exported
622 and with <em>warn</em>, they will be exported, but you will see a warning.</p></div>
623 </dd>
624 <dt class="hdlist1">
625 --tag-of-filtered-object=(abort|drop|rewrite)
626 </dt>
627 <dd>
629 Specify how to handle tags whose tagged object is filtered out.
630 Since revisions and files to export can be limited by path,
631 tagged objects may be filtered completely.
632 </p>
633 <div class="paragraph"><p>When asking to <em>abort</em> (which is the default), this program will die
634 when encountering such a tag. With <em>drop</em> it will omit such tags from
635 the output. With <em>rewrite</em>, if the tagged object is a commit, it will
636 rewrite the tag to tag an ancestor commit (via parent rewriting; see
637 <a href="git-rev-list.html">git-rev-list(1)</a>)</p></div>
638 </dd>
639 <dt class="hdlist1">
641 </dt>
642 <dt class="hdlist1">
644 </dt>
645 <dd>
647 Perform move and/or copy detection, as described in the
648 <a href="git-diff.html">git-diff(1)</a> manual page, and use it to generate
649 rename and copy commands in the output dump.
650 </p>
651 <div class="paragraph"><p>Note that earlier versions of this command did not complain and
652 produced incorrect results if you gave these options.</p></div>
653 </dd>
654 <dt class="hdlist1">
655 --export-marks=&lt;file&gt;
656 </dt>
657 <dd>
659 Dumps the internal marks table to &lt;file&gt; when complete.
660 Marks are written one per line as <tt>:markid SHA-1</tt>. Only marks
661 for revisions are dumped; marks for blobs are ignored.
662 Backends can use this file to validate imports after they
663 have been completed, or to save the marks table across
664 incremental runs. As &lt;file&gt; is only opened and truncated
665 at completion, the same path can also be safely given to
666 --import-marks.
667 </p>
668 </dd>
669 <dt class="hdlist1">
670 --import-marks=&lt;file&gt;
671 </dt>
672 <dd>
674 Before processing any input, load the marks specified in
675 &lt;file&gt;. The input file must exist, must be readable, and
676 must use the same format as produced by --export-marks.
677 </p>
678 <div class="paragraph"><p>Any commits that have already been marked will not be exported again.
679 If the backend uses a similar --import-marks file, this allows for
680 incremental bidirectional exporting of the repository by keeping the
681 marks the same across runs.</p></div>
682 </dd>
683 <dt class="hdlist1">
684 --fake-missing-tagger
685 </dt>
686 <dd>
688 Some old repositories have tags without a tagger. The
689 fast-import protocol was pretty strict about that, and did not
690 allow that. So fake a tagger to be able to fast-import the
691 output.
692 </p>
693 </dd>
694 <dt class="hdlist1">
695 --use-done-feature
696 </dt>
697 <dd>
699 Start the stream with a <em>feature done</em> stanza, and terminate
700 it with a <em>done</em> command.
701 </p>
702 </dd>
703 <dt class="hdlist1">
704 --no-data
705 </dt>
706 <dd>
708 Skip output of blob objects and instead refer to blobs via
709 their original SHA-1 hash. This is useful when rewriting the
710 directory structure or history of a repository without
711 touching the contents of individual files. Note that the
712 resulting stream can only be used by a repository which
713 already contains the necessary objects.
714 </p>
715 </dd>
716 <dt class="hdlist1">
717 --full-tree
718 </dt>
719 <dd>
721 This option will cause fast-export to issue a "deleteall"
722 directive for each commit followed by a full list of all files
723 in the commit (as opposed to just listing the files which are
724 different from the commit&#8217;s first parent).
725 </p>
726 </dd>
727 <dt class="hdlist1">
728 [&lt;git-rev-list-args&gt;&#8230;]
729 </dt>
730 <dd>
732 A list of arguments, acceptable to <em>git rev-parse</em> and
733 <em>git rev-list</em>, that specifies the specific objects and references
734 to export. For example, <tt>master&#126;10..master</tt> causes the
735 current master reference to be exported along with all objects
736 added since its 10th ancestor commit.
737 </p>
738 </dd>
739 </dl></div>
740 </div>
741 <h2 id="_examples">EXAMPLES</h2>
742 <div class="sectionbody">
743 <div class="listingblock">
744 <div class="content">
745 <pre><tt>$ git fast-export --all | (cd /empty/repository &amp;&amp; git fast-import)</tt></pre>
746 </div></div>
747 <div class="paragraph"><p>This will export the whole repository and import it into the existing
748 empty repository. Except for reencoding commits that are not in
749 UTF-8, it would be a one-to-one mirror.</p></div>
750 <div class="listingblock">
751 <div class="content">
752 <pre><tt>$ git fast-export master~5..master |
753 sed "s|refs/heads/master|refs/heads/other|" |
754 git fast-import</tt></pre>
755 </div></div>
756 <div class="paragraph"><p>This makes a new branch called <em>other</em> from <em>master~5..master</em>
757 (i.e. if <em>master</em> has linear history, it will take the last 5 commits).</p></div>
758 <div class="paragraph"><p>Note that this assumes that none of the blobs and commit messages
759 referenced by that revision range contains the string
760 <em>refs/heads/master</em>.</p></div>
761 </div>
762 <h2 id="_limitations">Limitations</h2>
763 <div class="sectionbody">
764 <div class="paragraph"><p>Since <em>git fast-import</em> cannot tag trees, you will not be
765 able to export the linux-2.6.git repository completely, as it contains
766 a tag referencing a tree instead of a commit.</p></div>
767 </div>
768 <h2 id="_git">GIT</h2>
769 <div class="sectionbody">
770 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
771 </div>
772 </div>
773 <div id="footnotes"><hr /></div>
774 <div id="footer">
775 <div id="footer-text">
776 Last updated 2011-09-21 23:01:14 PDT
777 </div>
778 </div>
779 </body>
780 </html>