Google Git
Sign in
chromium / external / gitster / git-htmldocs / aedeeaeb2294e47414178658ce93162ff4890da1 / . / git-fast-export.html
blob: fa7da217917cdb49fe2fe7963a6f6f9d15e501d6 [file] [log] [blame]
Junio C Hamanob9d9d902018-05-23 07:07:42[diff] [blame]1<?xml version="1.0" encoding="UTF-8"?>
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]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>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]6<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
Junio C Hamanoa85030a2022-07-27 16:48:21[diff] [blame]7<meta name="generator" content="AsciiDoc 10.2.0" />
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]8<title>git-fast-export(1)</title>
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]9<style type="text/css">
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]10/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
11
12/* Default font. */
13body {
14 font-family: Georgia,serif;
15}
16
17/* Title font. */
18h1, h2, h3, h4, h5, h6,
19div.title, caption.title,
20thead, p.table.header,
21#toctitle,
22#author, #revnumber, #revdate, #revremark,
23#footer {
24 font-family: Arial,Helvetica,sans-serif;
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]25}
26
27body {
28 margin: 1em 5% 1em 5%;
29}
30
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]31a {
32 color: blue;
33 text-decoration: underline;
34}
35a:visited {
36 color: fuchsia;
37}
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]38
39em {
40 font-style: italic;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]41 color: navy;
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]42}
43
44strong {
45 font-weight: bold;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]46 color: #083194;
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]47}
48
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]49h1, h2, h3, h4, h5, h6 {
50 color: #527bbd;
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]51 margin-top: 1.2em;
52 margin-bottom: 0.5em;
53 line-height: 1.3;
54}
55
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]56h1, h2, h3 {
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]57 border-bottom: 2px solid silver;
58}
59h2 {
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]60 padding-top: 0.5em;
61}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]62h3 {
63 float: left;
64}
65h3 + * {
66 clear: left;
67}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]68h5 {
69 font-size: 1.0em;
70}
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]71
72div.sectionbody {
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]73 margin-left: 0;
74}
75
76hr {
77 border: 1px solid silver;
78}
79
80p {
81 margin-top: 0.5em;
82 margin-bottom: 0.5em;
83}
84
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]85ul, ol, li > p {
86 margin-top: 0;
87}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]88ul > li { color: #aaa; }
89ul > li > * { color: black; }
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]90
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]91.monospaced, code, pre {
92 font-family: "Courier New", Courier, monospace;
93 font-size: inherit;
94 color: navy;
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]95 padding: 0;
96 margin: 0;
97}
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]98pre {
99 white-space: pre-wrap;
100}
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]101
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]102#author {
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]103 color: #527bbd;
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]104 font-weight: bold;
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]105 font-size: 1.1em;
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]106}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]107#email {
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]108}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]109#revnumber, #revdate, #revremark {
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]110}
111
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]112#footer {
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]113 font-size: small;
114 border-top: 2px solid silver;
115 padding-top: 0.5em;
116 margin-top: 4.0em;
117}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]118#footer-text {
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]119 float: left;
120 padding-bottom: 0.5em;
121}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]122#footer-badges {
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]123 float: right;
124 padding-bottom: 0.5em;
125}
126
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]127#preamble {
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]128 margin-top: 1.5em;
129 margin-bottom: 1.5em;
130}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]131div.imageblock, div.exampleblock, div.verseblock,
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]132div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
133div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]134 margin-top: 1.0em;
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]135 margin-bottom: 1.5em;
136}
137div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]138 margin-top: 2.0em;
139 margin-bottom: 2.0em;
140 margin-right: 10%;
141 color: #606060;
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]142}
143
144div.content { /* Block element content. */
145 padding: 0;
146}
147
148/* Block element titles. */
149div.title, caption.title {
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]150 color: #527bbd;
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]151 font-weight: bold;
152 text-align: left;
153 margin-top: 1.0em;
154 margin-bottom: 0.5em;
155}
156div.title + * {
157 margin-top: 0;
158}
159
160td div.title:first-child {
161 margin-top: 0.0em;
162}
163div.content div.title:first-child {
164 margin-top: 0.0em;
165}
166div.content + div.title {
167 margin-top: 0.0em;
168}
169
170div.sidebarblock > div.content {
171 background: #ffffee;
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]172 border: 1px solid #dddddd;
173 border-left: 4px solid #f0f0f0;
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]174 padding: 0.5em;
175}
176
177div.listingblock > div.content {
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]178 border: 1px solid #dddddd;
179 border-left: 5px solid #f0f0f0;
180 background: #f8f8f8;
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]181 padding: 0.5em;
182}
183
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]184div.quoteblock, div.verseblock {
185 padding-left: 1.0em;
186 margin-left: 1.0em;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]187 margin-right: 10%;
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]188 border-left: 5px solid #f0f0f0;
189 color: #888;
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]190}
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]191
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]192div.quoteblock > div.attribution {
193 padding-top: 0.5em;
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]194 text-align: right;
195}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]196
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]197div.verseblock > pre.content {
198 font-family: inherit;
199 font-size: inherit;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]200}
201div.verseblock > div.attribution {
202 padding-top: 0.75em;
203 text-align: left;
204}
205/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]206div.verseblock + div.attribution {
207 text-align: left;
208}
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]209
210div.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;
217}
218div.admonitionblock td.content {
219 padding-left: 0.5em;
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]220 border-left: 3px solid #dddddd;
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]221}
222
223div.exampleblock > div.content {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]224 border-left: 3px solid #dddddd;
225 padding-left: 0.5em;
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]226}
227
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]228div.imageblock div.content { padding-left: 0; }
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]229span.image img { border-style: none; vertical-align: text-bottom; }
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]230a.image:visited { color: white; }
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]231
232dl {
233 margin-top: 0.8em;
234 margin-bottom: 0.8em;
235}
236dt {
237 margin-top: 0.5em;
238 margin-bottom: 0;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]239 font-style: normal;
240 color: navy;
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]241}
242dd > *:first-child {
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]243 margin-top: 0.1em;
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]244}
245
246ul, ol {
247 list-style-position: outside;
248}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]249ol.arabic {
250 list-style-type: decimal;
251}
252ol.loweralpha {
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]253 list-style-type: lower-alpha;
254}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]255ol.upperalpha {
256 list-style-type: upper-alpha;
257}
258ol.lowerroman {
259 list-style-type: lower-roman;
260}
261ol.upperroman {
262 list-style-type: upper-roman;
263}
264
265div.compact ul, div.compact ol,
266div.compact p, div.compact p,
267div.compact div, div.compact div {
268 margin-top: 0.1em;
269 margin-bottom: 0.1em;
270}
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]271
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]272tfoot {
273 font-weight: bold;
274}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]275td > div.verse {
276 white-space: pre;
277}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]278
279div.hdlist {
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]280 margin-top: 0.8em;
281 margin-bottom: 0.8em;
282}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]283div.hdlist tr {
284 padding-bottom: 15px;
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]285}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]286dt.hdlist1.strong, td.hdlist1.strong {
287 font-weight: bold;
288}
289td.hdlist1 {
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]290 vertical-align: top;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]291 font-style: normal;
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]292 padding-right: 0.8em;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]293 color: navy;
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]294}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]295td.hdlist2 {
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]296 vertical-align: top;
297}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]298div.hdlist.compact tr {
299 margin: 0;
300 padding-bottom: 0;
301}
302
303.comment {
304 background: yellow;
305}
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]306
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]307.footnote, .footnoteref {
308 font-size: 0.8em;
309}
310
311span.footnote, span.footnoteref {
312 vertical-align: super;
313}
314
315#footnotes {
316 margin: 20px 0 20px 0;
317 padding: 7px 0 0 0;
318}
319
320#footnotes div.footnote {
321 margin: 0 0 5px 0;
322}
323
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;
332}
333
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]334div.colist td {
335 padding-right: 0.5em;
336 padding-bottom: 0.3em;
337 vertical-align: top;
338}
339div.colist td img {
340 margin-top: 0.3em;
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]341}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]342
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]343@media print {
344 #footer-badges { display: none; }
345}
346
347#toc {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]348 margin-bottom: 2.5em;
349}
350
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]351#toctitle {
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]352 color: #527bbd;
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]353 font-size: 1.1em;
354 font-weight: bold;
355 margin-top: 1.0em;
356 margin-bottom: 0.1em;
357}
358
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]359div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]360 margin-top: 0;
361 margin-bottom: 0;
362}
363div.toclevel2 {
364 margin-left: 2em;
365 font-size: 0.9em;
366}
367div.toclevel3 {
368 margin-left: 4em;
369 font-size: 0.9em;
370}
371div.toclevel4 {
372 margin-left: 6em;
373 font-size: 0.9em;
374}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]375
376span.aqua { color: aqua; }
377span.black { color: black; }
378span.blue { color: blue; }
379span.fuchsia { color: fuchsia; }
380span.gray { color: gray; }
381span.green { color: green; }
382span.lime { color: lime; }
383span.maroon { color: maroon; }
384span.navy { color: navy; }
385span.olive { color: olive; }
386span.purple { color: purple; }
387span.red { color: red; }
388span.silver { color: silver; }
389span.teal { color: teal; }
390span.white { color: white; }
391span.yellow { color: yellow; }
392
393span.aqua-background { background: aqua; }
394span.black-background { background: black; }
395span.blue-background { background: blue; }
396span.fuchsia-background { background: fuchsia; }
397span.gray-background { background: gray; }
398span.green-background { background: green; }
399span.lime-background { background: lime; }
400span.maroon-background { background: maroon; }
401span.navy-background { background: navy; }
402span.olive-background { background: olive; }
403span.purple-background { background: purple; }
404span.red-background { background: red; }
405span.silver-background { background: silver; }
406span.teal-background { background: teal; }
407span.white-background { background: white; }
408span.yellow-background { background: yellow; }
409
410span.big { font-size: 2em; }
411span.small { font-size: 0.6em; }
412
413span.underline { text-decoration: underline; }
414span.overline { text-decoration: overline; }
415span.line-through { text-decoration: line-through; }
416
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]417div.unbreakable { page-break-inside: avoid; }
418
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]419
420/*
421 * xhtml11 specific
422 *
423 * */
424
425div.tableblock {
426 margin-top: 1.0em;
427 margin-bottom: 1.5em;
428}
429div.tableblock > table {
430 border: 3px solid #527bbd;
431}
432thead, p.table.header {
433 font-weight: bold;
434 color: #527bbd;
435}
436p.table {
437 margin-top: 0;
438}
Junio C Hamano725b0da2020-01-22 22:02:40[diff] [blame]439/* Because the table frame attribute is overridden by CSS in most browsers. */
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]440div.tableblock > table[frame="void"] {
441 border-style: none;
442}
443div.tableblock > table[frame="hsides"] {
444 border-left-style: none;
445 border-right-style: none;
446}
447div.tableblock > table[frame="vsides"] {
448 border-top-style: none;
449 border-bottom-style: none;
450}
451
452
453/*
454 * html5 specific
455 *
456 * */
457
458table.tableblock {
459 margin-top: 1.0em;
460 margin-bottom: 1.5em;
461}
462thead, p.tableblock.header {
463 font-weight: bold;
464 color: #527bbd;
465}
466p.tableblock {
467 margin-top: 0;
468}
469table.tableblock {
470 border-width: 3px;
471 border-spacing: 0px;
472 border-style: solid;
473 border-color: #527bbd;
474 border-collapse: collapse;
475}
476th.tableblock, td.tableblock {
477 border-width: 1px;
478 padding: 4px;
479 border-style: solid;
480 border-color: #527bbd;
481}
482
483table.tableblock.frame-topbot {
484 border-left-style: hidden;
485 border-right-style: hidden;
486}
487table.tableblock.frame-sides {
488 border-top-style: hidden;
489 border-bottom-style: hidden;
490}
491table.tableblock.frame-none {
492 border-style: hidden;
493}
494
495th.tableblock.halign-left, td.tableblock.halign-left {
496 text-align: left;
497}
498th.tableblock.halign-center, td.tableblock.halign-center {
499 text-align: center;
500}
501th.tableblock.halign-right, td.tableblock.halign-right {
502 text-align: right;
503}
504
505th.tableblock.valign-top, td.tableblock.valign-top {
506 vertical-align: top;
507}
508th.tableblock.valign-middle, td.tableblock.valign-middle {
509 vertical-align: middle;
510}
511th.tableblock.valign-bottom, td.tableblock.valign-bottom {
512 vertical-align: bottom;
513}
514
515
516/*
517 * manpage specific
518 *
519 * */
520
521body.manpage h1 {
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]522 padding-top: 0.5em;
523 padding-bottom: 0.5em;
524 border-top: 2px solid silver;
525 border-bottom: 2px solid silver;
526}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]527body.manpage h2 {
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]528 border-style: none;
529}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]530body.manpage div.sectionbody {
531 margin-left: 3em;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]532}
533
534@media print {
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]535 body.manpage div#toc { display: none; }
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]536}
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]537
538
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]539</style>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]540<script type="text/javascript">
541/*<![CDATA[*/
Junio C Hamano2b153182021-12-15 21:00:31[diff] [blame]542var asciidoc = { // Namespace.
543
544/////////////////////////////////////////////////////////////////////
545// Table Of Contents generator
546/////////////////////////////////////////////////////////////////////
547
548/* Author: Mihai Bazon, September 2002
549 * http://students.infoiasi.ro/~mishoo
550 *
551 * Table Of Content generator
552 * Version: 0.4
553 *
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.
556 */
557
558 /* modified by Troy D. Hanson, September 2006. License: GPL */
559 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
560
561// toclevels = 1..4.
562toc: function (toclevels) {
563
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);
571 }
572 return text;
573 }
574
575 function TocEntry(el, text, toclevel) {
576 this.element = el;
577 this.text = text;
578 this.toclevel = toclevel;
579 }
580
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);
593 }
594 iterate(i);
595 }
596 }
597 }
598 iterate(el);
599 return result;
600 }
601
602 var toc = document.getElementById("toc");
603 if (!toc) {
604 return;
605 }
606
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);
616 }
617 for (i = 0; i < tocEntriesToRemove.length; i++) {
618 toc.removeChild(tocEntriesToRemove[i]);
619 }
620
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);
634 }
635 if (entries.length == 0)
636 toc.parentNode.removeChild(toc);
637},
638
639
640/////////////////////////////////////////////////////////////////////
641// Footnotes generator
642/////////////////////////////////////////////////////////////////////
643
644/* Based on footnote generation code from:
645 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
646 */
647
648footnotes: 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;
654 }
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);
660 }
661 for (i = 0; i < entriesToRemove.length; i++) {
662 noteholder.removeChild(entriesToRemove[i]);
663 }
664
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);
682 }
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;
689 }
690 }
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>]";
703 }
704 }
705 }
706},
707
708install: function(toclevels) {
709 var timerId;
710
711 function reinstall() {
712 asciidoc.footnotes();
713 if (toclevels) {
714 asciidoc.toc(toclevels);
715 }
716 }
717
718 function reinstallAndRemoveTimer() {
719 clearInterval(timerId);
720 reinstall();
721 }
722
723 timerId = setInterval(reinstall, 500);
724 if (document.addEventListener)
725 document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
726 else
727 window.onload = reinstallAndRemoveTimer;
728}
729
730}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]731asciidoc.install();
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]732/*]]>*/
733</script>
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]734</head>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]735<body class="manpage">
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]736<div id="header">
737<h1>
738git-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>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]747<div id="content">
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]748<div class="sect1">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]749<h2 id="_synopsis">SYNOPSIS</h2>
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]750<div class="sectionbody">
Junio C Hamano15567bc2011-07-23 00:51:59[diff] [blame]751<div class="verseblock">
Junio C Hamanocf9c7732022-10-28 18:56:06[diff] [blame]752<pre class="content"><em>git fast-export</em> [&lt;options&gt;] | <em>git fast-import</em></pre>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]753<div class="attribution">
Junio C Hamano15567bc2011-07-23 00:51:59[diff] [blame]754</div></div>
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]755</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]756</div>
757<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]758<h2 id="_description">DESCRIPTION</h2>
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]759<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]760<div class="paragraph"><p>This program dumps the given revisions in a form suitable to be piped
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]761into <em>git fast-import</em>.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]762<div class="paragraph"><p>You can use it as a human-readable bundle replacement (see
Junio C Hamanoa8858312019-09-30 05:07:45[diff] [blame]763<a href="git-bundle.html">git-bundle(1)</a>), or as a format that can be edited before being
764fed to <em>git fast-import</em> in order to do history rewrites (an ability
765relied on by tools like <em>git filter-repo</em>).</p></div>
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]766</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]767</div>
768<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]769<h2 id="_options">OPTIONS</h2>
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]770<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]771<div class="dlist"><dl>
772<dt class="hdlist1">
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]773--progress=&lt;n&gt;
774</dt>
775<dd>
776<p>
777 Insert <em>progress</em> statements every &lt;n&gt; objects, to be shown by
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]778 <em>git fast-import</em> during import.
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]779</p>
780</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]781<dt class="hdlist1">
Junio C Hamanoac002b62013-04-25 01:02:58[diff] [blame]782--signed-tags=(verbatim|warn|warn-strip|strip|abort)
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]783</dt>
784<dd>
785<p>
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>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]790<div class="paragraph"><p>When asking to <em>abort</em> (which is the default), this program will die
Junio C Hamanoac002b62013-04-25 01:02:58[diff] [blame]791when encountering a signed tag. With <em>strip</em>, the tags will silently
792be made unsigned, with <em>warn-strip</em> they will be made unsigned but a
793warning will be displayed, with <em>verbatim</em>, they will be silently
794exported and with <em>warn</em>, they will be exported, but you will see a
795warning.</p></div>
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]796</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]797<dt class="hdlist1">
Junio C Hamanoceec6ab2009-07-26 21:37:52[diff] [blame]798--tag-of-filtered-object=(abort|drop|rewrite)
799</dt>
800<dd>
801<p>
Junio C Hamano167b1382010-01-31 23:04:31[diff] [blame]802 Specify how to handle tags whose tagged object is filtered out.
Junio C Hamanoceec6ab2009-07-26 21:37:52[diff] [blame]803 Since revisions and files to export can be limited by path,
804 tagged objects may be filtered completely.
805</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]806<div class="paragraph"><p>When asking to <em>abort</em> (which is the default), this program will die
Junio C Hamanoceec6ab2009-07-26 21:37:52[diff] [blame]807when encountering such a tag. With <em>drop</em> it will omit such tags from
808the output. With <em>rewrite</em>, if the tagged object is a commit, it will
809rewrite the tag to tag an ancestor commit (via parent rewriting; see
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]810<a href="git-rev-list.html">git-rev-list(1)</a>)</p></div>
Junio C Hamanoceec6ab2009-07-26 21:37:52[diff] [blame]811</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]812<dt class="hdlist1">
Junio C Hamano7f80ae82008-07-30 18:31:35[diff] [blame]813-M
814</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]815<dt class="hdlist1">
Junio C Hamano7f80ae82008-07-30 18:31:35[diff] [blame]816-C
817</dt>
818<dd>
819<p>
820 Perform move and/or copy detection, as described in the
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]821 <a href="git-diff.html">git-diff(1)</a> manual page, and use it to generate
Junio C Hamano7f80ae82008-07-30 18:31:35[diff] [blame]822 rename and copy commands in the output dump.
823</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]824<div class="paragraph"><p>Note that earlier versions of this command did not complain and
Junio C Hamano7f80ae82008-07-30 18:31:35[diff] [blame]825produced incorrect results if you gave these options.</p></div>
826</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]827<dt class="hdlist1">
Junio C Hamano4224f992008-06-23 07:14:08[diff] [blame]828--export-marks=&lt;file&gt;
829</dt>
830<dd>
831<p>
832 Dumps the internal marks table to &lt;file&gt; when complete.
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]833 Marks are written one per line as <code>:markid SHA-1</code>. Only marks
Junio C Hamano4224f992008-06-23 07:14:08[diff] [blame]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.
Junio C Hamano63b6fdb2013-04-07 23:37:13[diff] [blame]840 The file will not be written if no new object has been
841 marked/exported.
Junio C Hamano4224f992008-06-23 07:14:08[diff] [blame]842</p>
843</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]844<dt class="hdlist1">
Junio C Hamano4224f992008-06-23 07:14:08[diff] [blame]845--import-marks=&lt;file&gt;
846</dt>
847<dd>
848<p>
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>
Junio C Hamanofa2a48b2019-10-15 05:24:40[diff] [blame]853</dd>
854<dt class="hdlist1">
855--mark-tags
856</dt>
857<dd>
858<p>
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
868exported again. If the backend uses a similar --import-marks file,
869this allows for incremental bidirectional exporting of the repository
870by keeping the marks the same across runs.</p></div>
Junio C Hamano4224f992008-06-23 07:14:08[diff] [blame]871</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]872<dt class="hdlist1">
Junio C Hamano54bf1e22008-12-20 06:30:11[diff] [blame]873--fake-missing-tagger
874</dt>
875<dd>
876<p>
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>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]883<dt class="hdlist1">
Junio C Hamanofbc773c2011-08-02 00:09:12[diff] [blame]884--use-done-feature
885</dt>
886<dd>
887<p>
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">
Junio C Hamanobacccda2009-08-03 08:07:12[diff] [blame]893--no-data
894</dt>
895<dd>
896<p>
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>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]905<dt class="hdlist1">
Junio C Hamano075ae872010-09-01 18:43:07[diff] [blame]906--full-tree
907</dt>
908<dd>
909<p>
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
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]913 different from the commit&#8217;s first parent).
Junio C Hamano075ae872010-09-01 18:43:07[diff] [blame]914</p>
915</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]916<dt class="hdlist1">
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]917--anonymize
918</dt>
919<dd>
920<p>
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">
Junio C Hamanoa8911782020-07-07 05:35:57[diff] [blame]927--anonymize-map=&lt;from&gt;[:&lt;to&gt;]
928</dt>
929<dd>
930<p>
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">
Junio C Hamanode48f452019-01-04 22:31:57[diff] [blame]937--reference-excluded-parents
938</dt>
939<dd>
940<p>
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
Junio C Hamano556b57e2019-08-12 17:46:38[diff] [blame]946 --reference-excluded-parents to instead have the stream
Junio C Hamanode48f452019-01-04 22:31:57[diff] [blame]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>
957<p>
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">
Junio C Hamano51937872019-06-13 22:09:30[diff] [blame]966--reencode=(yes|no|abort)
967</dt>
968<dd>
969<p>
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
Junio C Hamano8ef91f32019-12-01 22:58:27[diff] [blame]973 message will be re-encoded into UTF-8. With <em>no</em>, the original
Junio C Hamano51937872019-06-13 22:09:30[diff] [blame]974 encoding will be preserved.
975</p>
976</dd>
977<dt class="hdlist1">
Junio C Hamanoc8c398a2014-06-16 21:14:05[diff] [blame]978--refspec
979</dt>
980<dd>
981<p>
982 Apply the specified refspec to each ref exported. Multiple of them can
983 be specified.
984</p>
985</dd>
986<dt class="hdlist1">
Junio C Hamanod2179ef2010-10-22 04:12:17[diff] [blame]987[&lt;git-rev-list-args&gt;&#8230;]
Junio C Hamanoceec6ab2009-07-26 21:37:52[diff] [blame]988</dt>
989<dd>
990<p>
Junio C Hamano3d1b5a12013-05-17 23:34:02[diff] [blame]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
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]993 to export. For example, <code>master~10..master</code> causes the
Junio C Hamano3d1b5a12013-05-17 23:34:02[diff] [blame]994 current master reference to be exported along with all objects
Junio C Hamanode48f452019-01-04 22:31:57[diff] [blame]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.
Junio C Hamanoceec6ab2009-07-26 21:37:52[diff] [blame]998</p>
999</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1000</dl></div>
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]1001</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1002</div>
1003<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1004<h2 id="_examples">EXAMPLES</h2>
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]1005<div class="sectionbody">
1006<div class="listingblock">
1007<div class="content">
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1008<pre><code>$ git fast-export --all | (cd /empty/repository &amp;&amp; git fast-import)</code></pre>
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]1009</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1010<div class="paragraph"><p>This will export the whole repository and import it into the existing
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]1011empty repository. Except for reencoding commits that are not in
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1012UTF-8, it would be a one-to-one mirror.</p></div>
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]1013<div class="listingblock">
1014<div class="content">
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1015<pre><code>$ git fast-export master~5..master |
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]1016 sed "s|refs/heads/master|refs/heads/other|" |
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1017 git fast-import</code></pre>
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]1018</div></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1019<div class="paragraph"><p>This makes a new branch called <em>other</em> from <em>master~5..master</em>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1020(i.e. if <em>master</em> has linear history, it will take the last 5 commits).</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1021<div class="paragraph"><p>Note that this assumes that none of the blobs and commit messages
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]1022referenced by that revision range contains the string
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1023<em>refs/heads/master</em>.</p></div>
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]1024</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1025</div>
1026<div class="sect1">
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]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
1030identifying information from the repository while still retaining enough
1031of the original tree and history patterns to reproduce some bugs. The
1032goal is that a git bug which is found on a private repository will
1033persist in the anonymized repository, and the latter can be shared with
1034git developers to help solve the bug.</p></div>
1035<div class="paragraph"><p>With this option, git will replace all refnames, paths, blob contents,
1036commit and tag messages, names, and email addresses in the output with
1037anonymized data. Two instances of the same string will be replaced
1038equivalently (e.g., two commits with the same author will have the same
1039anonymized author in the output, but bear no resemblance to the original
1040author string). The relationship between commits, branches, and tags is
1041retained, as well as the commit timestamps (but the commit messages and
1042refnames bear no resemblance to the originals). The relative makeup of
1043the tree is retained (e.g., if you have a root tree with 10 files and 3
1044trees, so will the output), but their names and the contents of the
1045files 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
1047anonymized 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
1053stream (many bugs will not, as they really do depend on the exact
1054repository 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
1064stream compresses very well, so gzipping it is encouraged. If you want
1065to examine the stream to see that it does not contain any private data,
1066you 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
1072collapse "User 0", "User 1", etc into "User X"). This produces a much
1073smaller output, and it is usually easy to quickly confirm that there is
1074no private data in the stream.</p></div>
Junio C Hamanoa8911782020-07-07 05:35:57[diff] [blame]1075<div class="paragraph"><p>Reproducing some bugs may require referencing particular commits or
1076paths, which becomes challenging after refnames and paths have been
1077anonymized. You can ask for a particular token to be left as-is or
1078mapped to a new value. For example, if you have a bug which reproduces
1079with <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>
1088in the anonymized repository.</p></div>
1089<div class="paragraph"><p>Note that paths and refnames are split into tokens at slash boundaries.
1090The 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
1092repository to determine the final pathname.</p></div>
1093<div class="paragraph"><p>To make referencing the final pathname simpler, you can map each path
1094component; so if you also anonymize <code>subdir</code> to <code>publicdir</code>, then the
1095final pathname would be <code>publicdir/bar.c</code>.</p></div>
Junio C Hamanoac12f0e2014-09-19 22:32:51[diff] [blame]1096</div>
1097</div>
1098<div class="sect1">
Junio C Hamanob9d9d902018-05-23 07:07:42[diff] [blame]1099<h2 id="_limitations">LIMITATIONS</h2>
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]1100<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1101<div class="paragraph"><p>Since <em>git fast-import</em> cannot tag trees, you will not be
Junio C Hamanoa1952302013-07-01 21:31:18[diff] [blame]1102able to export the linux.git repository completely, as it contains
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1103a tag referencing a tree instead of a commit.</p></div>
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]1104</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1105</div>
1106<div class="sect1">
Junio C Hamano13220242014-11-19 23:06:27[diff] [blame]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">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1113<h2 id="_git">GIT</h2>
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]1114<div class="sectionbody">
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]1115<div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]1116</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]1117</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1118</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]1119<div id="footnotes"><hr /></div>
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]1120<div id="footer">
1121<div id="footer-text">
Junio C Hamano2ef0ba32018-01-26 23:13:53[diff] [blame]1122Last updated
Junio C Hamanoa7b2c102023-06-13 21:00:15[diff] [blame]1123 2022-10-28 11:53:56 PDT
Junio C Hamano0c999702007-12-03 09:57:55[diff] [blame]1124</div>
1125</div>
1126</body>
1127</html>