1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 10.2.0" />
<title>git-fast-import(1)</title>
<style type="text/css">
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
/* Default font. */
body {
font-family: Georgia,serif;
}
/* Title font. */
h1, h2, h3, h4, h5, h6,
div.title, caption.title,
thead, p.table.header,
#toctitle,
#author, #revnumber, #revdate, #revremark,
#footer {
font-family: Arial,Helvetica,sans-serif;
}
body {
margin: 1em 5% 1em 5%;
}
a {
color: blue;
text-decoration: underline;
}
a:visited {
color: fuchsia;
}
em {
font-style: italic;
color: navy;
}
strong {
font-weight: bold;
color: #083194;
}
h1, h2, h3, h4, h5, h6 {
color: #527bbd;
margin-top: 1.2em;
margin-bottom: 0.5em;
line-height: 1.3;
}
h1, h2, h3 {
border-bottom: 2px solid silver;
}
h2 {
padding-top: 0.5em;
}
h3 {
float: left;
}
h3 + * {
clear: left;
}
h5 {
font-size: 1.0em;
}
div.sectionbody {
margin-left: 0;
}
hr {
border: 1px solid silver;
}
p {
margin-top: 0.5em;
margin-bottom: 0.5em;
}
ul, ol, li > p {
margin-top: 0;
}
ul > li { color: #aaa; }
ul > li > * { color: black; }
.monospaced, code, pre {
font-family: "Courier New", Courier, monospace;
font-size: inherit;
color: navy;
padding: 0;
margin: 0;
}
pre {
white-space: pre-wrap;
}
#author {
color: #527bbd;
font-weight: bold;
font-size: 1.1em;
}
#email {
}
#revnumber, #revdate, #revremark {
}
#footer {
font-size: small;
border-top: 2px solid silver;
padding-top: 0.5em;
margin-top: 4.0em;
}
#footer-text {
float: left;
padding-bottom: 0.5em;
}
#footer-badges {
float: right;
padding-bottom: 0.5em;
}
#preamble {
margin-top: 1.5em;
margin-bottom: 1.5em;
}
div.imageblock, div.exampleblock, div.verseblock,
div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
div.admonitionblock {
margin-top: 1.0em;
margin-bottom: 1.5em;
}
div.admonitionblock {
margin-top: 2.0em;
margin-bottom: 2.0em;
margin-right: 10%;
color: #606060;
}
div.content { /* Block element content. */
padding: 0;
}
/* Block element titles. */
div.title, caption.title {
color: #527bbd;
font-weight: bold;
text-align: left;
margin-top: 1.0em;
margin-bottom: 0.5em;
}
div.title + * {
margin-top: 0;
}
td div.title:first-child {
margin-top: 0.0em;
}
div.content div.title:first-child {
margin-top: 0.0em;
}
div.content + div.title {
margin-top: 0.0em;
}
div.sidebarblock > div.content {
background: #ffffee;
border: 1px solid #dddddd;
border-left: 4px solid #f0f0f0;
padding: 0.5em;
}
div.listingblock > div.content {
border: 1px solid #dddddd;
border-left: 5px solid #f0f0f0;
background: #f8f8f8;
padding: 0.5em;
}
div.quoteblock, div.verseblock {
padding-left: 1.0em;
margin-left: 1.0em;
margin-right: 10%;
border-left: 5px solid #f0f0f0;
color: #888;
}
div.quoteblock > div.attribution {
padding-top: 0.5em;
text-align: right;
}
div.verseblock > pre.content {
font-family: inherit;
font-size: inherit;
}
div.verseblock > div.attribution {
padding-top: 0.75em;
text-align: left;
}
/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
div.verseblock + div.attribution {
text-align: left;
}
div.admonitionblock .icon {
vertical-align: top;
font-size: 1.1em;
font-weight: bold;
text-decoration: underline;
color: #527bbd;
padding-right: 0.5em;
}
div.admonitionblock td.content {
padding-left: 0.5em;
border-left: 3px solid #dddddd;
}
div.exampleblock > div.content {
border-left: 3px solid #dddddd;
padding-left: 0.5em;
}
div.imageblock div.content { padding-left: 0; }
span.image img { border-style: none; vertical-align: text-bottom; }
a.image:visited { color: white; }
dl {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
dt {
margin-top: 0.5em;
margin-bottom: 0;
font-style: normal;
color: navy;
}
dd > *:first-child {
margin-top: 0.1em;
}
ul, ol {
list-style-position: outside;
}
ol.arabic {
list-style-type: decimal;
}
ol.loweralpha {
list-style-type: lower-alpha;
}
ol.upperalpha {
list-style-type: upper-alpha;
}
ol.lowerroman {
list-style-type: lower-roman;
}
ol.upperroman {
list-style-type: upper-roman;
}
div.compact ul, div.compact ol,
div.compact p, div.compact p,
div.compact div, div.compact div {
margin-top: 0.1em;
margin-bottom: 0.1em;
}
tfoot {
font-weight: bold;
}
td > div.verse {
white-space: pre;
}
div.hdlist {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
div.hdlist tr {
padding-bottom: 15px;
}
dt.hdlist1.strong, td.hdlist1.strong {
font-weight: bold;
}
td.hdlist1 {
vertical-align: top;
font-style: normal;
padding-right: 0.8em;
color: navy;
}
td.hdlist2 {
vertical-align: top;
}
div.hdlist.compact tr {
margin: 0;
padding-bottom: 0;
}
.comment {
background: yellow;
}
.footnote, .footnoteref {
font-size: 0.8em;
}
span.footnote, span.footnoteref {
vertical-align: super;
}
#footnotes {
margin: 20px 0 20px 0;
padding: 7px 0 0 0;
}
#footnotes div.footnote {
margin: 0 0 5px 0;
}
#footnotes hr {
border: none;
border-top: 1px solid silver;
height: 1px;
text-align: left;
margin-left: 0;
width: 20%;
min-width: 100px;
}
div.colist td {
padding-right: 0.5em;
padding-bottom: 0.3em;
vertical-align: top;
}
div.colist td img {
margin-top: 0.3em;
}
@media print {
#footer-badges { display: none; }
}
#toc {
margin-bottom: 2.5em;
}
#toctitle {
color: #527bbd;
font-size: 1.1em;
font-weight: bold;
margin-top: 1.0em;
margin-bottom: 0.1em;
}
div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
margin-top: 0;
margin-bottom: 0;
}
div.toclevel2 {
margin-left: 2em;
font-size: 0.9em;
}
div.toclevel3 {
margin-left: 4em;
font-size: 0.9em;
}
div.toclevel4 {
margin-left: 6em;
font-size: 0.9em;
}
span.aqua { color: aqua; }
span.black { color: black; }
span.blue { color: blue; }
span.fuchsia { color: fuchsia; }
span.gray { color: gray; }
span.green { color: green; }
span.lime { color: lime; }
span.maroon { color: maroon; }
span.navy { color: navy; }
span.olive { color: olive; }
span.purple { color: purple; }
span.red { color: red; }
span.silver { color: silver; }
span.teal { color: teal; }
span.white { color: white; }
span.yellow { color: yellow; }
span.aqua-background { background: aqua; }
span.black-background { background: black; }
span.blue-background { background: blue; }
span.fuchsia-background { background: fuchsia; }
span.gray-background { background: gray; }
span.green-background { background: green; }
span.lime-background { background: lime; }
span.maroon-background { background: maroon; }
span.navy-background { background: navy; }
span.olive-background { background: olive; }
span.purple-background { background: purple; }
span.red-background { background: red; }
span.silver-background { background: silver; }
span.teal-background { background: teal; }
span.white-background { background: white; }
span.yellow-background { background: yellow; }
span.big { font-size: 2em; }
span.small { font-size: 0.6em; }
span.underline { text-decoration: underline; }
span.overline { text-decoration: overline; }
span.line-through { text-decoration: line-through; }
div.unbreakable { page-break-inside: avoid; }
/*
* xhtml11 specific
*
* */
div.tableblock {
margin-top: 1.0em;
margin-bottom: 1.5em;
}
div.tableblock > table {
border: 3px solid #527bbd;
}
thead, p.table.header {
font-weight: bold;
color: #527bbd;
}
p.table {
margin-top: 0;
}
/* Because the table frame attribute is overridden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
border-style: none;
}
div.tableblock > table[frame="hsides"] {
border-left-style: none;
border-right-style: none;
}
div.tableblock > table[frame="vsides"] {
border-top-style: none;
border-bottom-style: none;
}
/*
* html5 specific
*
* */
table.tableblock {
margin-top: 1.0em;
margin-bottom: 1.5em;
}
thead, p.tableblock.header {
font-weight: bold;
color: #527bbd;
}
p.tableblock {
margin-top: 0;
}
table.tableblock {
border-width: 3px;
border-spacing: 0px;
border-style: solid;
border-color: #527bbd;
border-collapse: collapse;
}
th.tableblock, td.tableblock {
border-width: 1px;
padding: 4px;
border-style: solid;
border-color: #527bbd;
}
table.tableblock.frame-topbot {
border-left-style: hidden;
border-right-style: hidden;
}
table.tableblock.frame-sides {
border-top-style: hidden;
border-bottom-style: hidden;
}
table.tableblock.frame-none {
border-style: hidden;
}
th.tableblock.halign-left, td.tableblock.halign-left {
text-align: left;
}
th.tableblock.halign-center, td.tableblock.halign-center {
text-align: center;
}
th.tableblock.halign-right, td.tableblock.halign-right {
text-align: right;
}
th.tableblock.valign-top, td.tableblock.valign-top {
vertical-align: top;
}
th.tableblock.valign-middle, td.tableblock.valign-middle {
vertical-align: middle;
}
th.tableblock.valign-bottom, td.tableblock.valign-bottom {
vertical-align: bottom;
}
/*
* manpage specific
*
* */
body.manpage h1 {
padding-top: 0.5em;
padding-bottom: 0.5em;
border-top: 2px solid silver;
border-bottom: 2px solid silver;
}
body.manpage h2 {
border-style: none;
}
body.manpage div.sectionbody {
margin-left: 3em;
}
@media print {
body.manpage div#toc { display: none; }
}
</style>
<script type="text/javascript">
/*<+'])');
// Function that scans the DOM tree for header elements (the DOM2
// nodeIterator API would be a better technique but not supported by all
// browsers).
var iterate = function (el) {
for (var i = el.firstChild; i != null; i = i.nextSibling) {
if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
var mo = re.exec(i.tagName);
if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
}
iterate(i);
}
}
}
iterate(el);
return result;
}
var toc = document.getElementById("toc");
if (!toc) {
return;
}
// Delete existing TOC entries in case we're reloading the TOC.
var tocEntriesToRemove = [];
var i;
for (i = 0; i < toc.childNodes.length; i++) {
var entry = toc.childNodes[i];
if (entry.nodeName.toLowerCase() == 'div'
&& entry.getAttribute("class")
&& entry.getAttribute("class").match(/^toclevel/))
tocEntriesToRemove.push(entry);
}
for (i = 0; i < tocEntriesToRemove.length; i++) {
toc.removeChild(tocEntriesToRemove[i]);
}
// Rebuild TOC entries.
var entries = tocEntries(document.getElementById("content"), toclevels);
for (var i = 0; i < entries.length; ++i) {
var entry = entries[i];
if (entry.element.id == "")
entry.element.id = "_toc_" + i;
var a = document.createElement("a");
a.href = "#" + entry.element.id;
a.appendChild(document.createTextNode(entry.text));
var div = document.createElement("div");
div.appendChild(a);
div.className = "toclevel" + entry.toclevel;
toc.appendChild(div);
}
if (entries.length == 0)
toc.parentNode.removeChild(toc);
},
/////////////////////////////////////////////////////////////////////
// Footnotes generator
/////////////////////////////////////////////////////////////////////
/* Based on footnote generation code from:
* http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
*/
footnotes: function () {
// Delete existing footnote entries in case we're reloading the footnodes.
var i;
var noteholder = document.getElementById("footnotes");
if (!noteholder) {
return;
}
var entriesToRemove = [];
for (i = 0; i < noteholder.childNodes.length; i++) {
var entry = noteholder.childNodes[i];
if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
entriesToRemove.push(entry);
}
for (i = 0; i < entriesToRemove.length; i++) {
noteholder.removeChild(entriesToRemove[i]);
}
// Rebuild footnote entries.
var cont = document.getElementById("content");
var spans = cont.getElementsByTagName("span");
var refs = {};
var n = 0;
for (i=0; i<spans.length; i++) {
if (spans[i].className == "footnote") {
n++;
var note = spans[i].getAttribute("data-note");
if (!note) {
// Use [\s\S] in place of . so multi-line matches work.
// Because JavaScript has no s (dotall) regex flag.
note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
spans[i].innerHTML =
"[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
"' title='View footnote' class='footnote'>" + n + "</a>]";
spans[i].setAttribute("data-note", note);
}
noteholder.innerHTML +=
"<div class='footnote' id='_footnote_" + n + "'>" +
"<a href='#_footnoteref_" + n + "' title='Return to text'>" +
n + "</a>. " + note + "</div>";
var id =spans[i].getAttribute("id");
if (id != null) refs["#"+id] = n;
}
}
if (n == 0)
noteholder.parentNode.removeChild(noteholder);
else {
// Process footnoterefs.
for (i=0; i<spans.length; i++) {
if (spans[i].className == "footnoteref") {
var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
href = href.match(/#.*/)[0]; // Because IE return full URL.
n = refs[href];
spans[i].innerHTML =
"[<a href='#_footnote_" + n +
"' title='View footnote' class='footnote'>" + n + "</a>]";
}
}
}
},
install: function(toclevels) {
var timerId;
function reinstall() {
asciidoc.footnotes();
if (toclevels) {
asciidoc.toc(toclevels);
}
}
function reinstallAndRemoveTimer() {
clearInterval(timerId);
reinstall();
}
timerId = setInterval(reinstall, 500);
if (document.addEventListener)
document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
else
window.onload = reinstallAndRemoveTimer;
}
}
asciidoc.install();
/*]]>*/
</script>
</head>
<body class="manpage">
<div id="header">
<h1>
git-fast-import(1) Manual Page
</h1>
<h2>NAME</h2>
<div class="sectionbody">
<p>git-fast-import -
Backend for fast Git data importers
</p>
</div>
</div>
<div id="content">
<div class="sect1">
<h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="verseblock">
<pre class="content">frontend | <em>git fast-import</em> [<options>]</pre>
<div class="attribution">
</div></div>
</div>
</div>
<div class="sect1">
<h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
<div class="paragraph"><p>This program is usually not what the end user wants to run directly.
Most end users want to use one of the existing frontend programs,
which parses a specific type of foreign source and feeds the contents
stored there to <em>git fast-import</em>.</p></div>
<div class="paragraph"><p>fast-import reads a mixed command/data stream from standard input and
writes one or more packfiles directly into the current repository.
When EOF is received on standard input, fast import writes out
updated branch and tag refs, fully updating the current repository
with the newly imported data.</p></div>
<div class="paragraph"><p>The fast-import backend itself can import into an empty repository (one that
has already been initialized by <em>git init</em>) or incrementally
update an existing populated repository. Whether or not incremental
imports are supported from a particular foreign source depends on
the frontend program in use.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_options">OPTIONS</h2>
<div class="sectionbody">
<div class="dlist"><dl>
<dt class="hdlist1">
--force
</dt>
<dd>
<p>
Force updating modified existing branches, even if doing
so would cause commits to be lost (as the new commit does
not contain the old commit).
</p>
</dd>
<dt class="hdlist1">
--quiet
</dt>
<dd>
<p>
Disable the output shown by --stats, making fast-import usually
be silent when it is successful. However, if the import stream
has directives intended to show user output (e.g. <code>progress</code>
directives), the corresponding messages will still be shown.
</p>
</dd>
<dt class="hdlist1">
--stats
</dt>
<dd>
<p>
Display some basic statistics about the objects fast-import has
created, the packfiles they were stored into, and the
memory used by fast-import during this run. Showing this output
is currently the default, but can be disabled with --quiet.
</p>
</dd>
<dt class="hdlist1">
--allow-unsafe-features
</dt>
<dd>
<p>
Many command-line options can be provided as part of the
fast-import stream itself by using the <code>feature</code> or <code>option</code>
commands. However, some of these options are unsafe (e.g.,
allowing fast-import to access the filesystem outside of the
repository). These options are disabled by default, but can be
allowed by providing this option on the command line. This
currently impacts only the <code>export-marks</code>, <code>import-marks</code>, and
<code>import-marks-if-exists</code> feature commands.
</p>
<div class="literalblock">
<div class="content">
<pre><code>Only enable this option if you trust the program generating the
fast-import stream! This option is enabled automatically for
remote-helpers that use the `import` capability, as they are
already trusted to run their own code.</code></pre>
</div></div>
</dd>
</dl></div>
<div class="sect2">
<h3 id="_options_for_frontends">Options for Frontends</h3>
<div class="dlist"><dl>
<dt class="hdlist1">
--cat-blob-fd=<fd>
</dt>
<dd>
<p>
Write responses to <code>get-mark</code>, <code>cat-blob</code>, and <code>ls</code> queries to the
file descriptor <fd> instead of <code>stdout</code>. Allows <code>progress</code>
output intended for the end-user to be separated from other
output.
</p>
</dd>
<dt class="hdlist1">
--date-format=<fmt>
</dt>
<dd>
<p>
Specify the type of dates the frontend will supply to
fast-import within <code>author</code>, <code>committer</code> and <code>tagger</code> commands.
See “Date Formats” below for details about which formats
are supported, and their syntax.
</p>
</dd>
<dt class="hdlist1">
--done
</dt>
<dd>
<p>
Terminate with error if there is no <code>done</code> command at the end of
the stream. This option might be useful for detecting errors
that cause the frontend to terminate before it has started to
write a stream.
</p>
</dd>
</dl></div>
</div>
<div class="sect2">
<h3 id="_locations_of_marks_files">Locations of Marks Files</h3>
<div class="dlist"><dl>
<dt class="hdlist1">
--export-marks=<file>
</dt>
<dd>
<p>
Dumps the internal marks table to <file> when complete.
Marks are written one per line as <code>:markid SHA-1</code>.
Frontends can use this file to validate imports after they
have been completed, or to save the marks table across
incremental runs. As <file> is only opened and truncated
at checkpoint (or completion) the same path can also be
safely given to --import-marks.
</p>
</dd>
<dt class="hdlist1">
--import-marks=<file>
</dt>
<dd>
<p>
Before processing any input, load the marks specified in
<file>. The input file must exist, must be readable, and
must use the same format as produced by --export-marks.
Multiple options may be supplied to import more than one
set of marks. If a mark is defined to different values,
the last file wins.
</p>
</dd>
<dt class="hdlist1">
--import-marks-if-exists=<file>
</dt>
<dd>
<p>
Like --import-marks but instead of erroring out, silently
skips the file if it does not exist.
</p>
</dd>
<dt class="hdlist1">
--[no-]relative-marks
</dt>
<dd>
<p>
After specifying --relative-marks the paths specified
with --import-marks= and --export-marks= are relative
to an internal directory in the current repository.
In git-fast-import this means that the paths are relative
to the .git/info/fast-import directory. However, other
importers may use a different location.
</p>
<div class="paragraph"><p>Relative and non-relative marks may be combined by interweaving
--(no-)-relative-marks with the --(import|export)-marks= options.</p></div>
</dd>
</dl></div>
</div>
<div class="sect2">
<h3 id="_submodule_rewriting">Submodule Rewriting</h3>
<div class="dlist"><dl>
<dt class="hdlist1">
--rewrite-submodules-from=<name>:<file>
</dt>
<dt class="hdlist1">
--rewrite-submodules-to=<name>:<file>
</dt>
<dd>
<p>
Rewrite the object IDs for the submodule specified by <name> from the values
used in the from <file> to those used in the to <file>. The from marks should
have been created by <code>git fast-export</code>, and the to marks should have been
created by <code>git fast-import</code> when importing that same submodule.
</p>
<div class="paragraph"><p><name> may be any arbitrary string not containing a colon character, but the
same value must be used with both options when specifying corresponding marks.
Multiple submodules may be specified with different values for <name>. It is an
error not to use these options in corresponding pairs.</p></div>
<div class="paragraph"><p>These options are primarily useful when converting a repository from one hash
algorithm to another; without them, fast-import will fail if it encounters a
submodule because it has no way of writing the object ID into the new hash
algorithm.</p></div>
</dd>
</dl></div>
</div>
<div class="sect2">
<h3 id="_performance_and_compression_tuning">Performance and Compression Tuning</h3>
<div class="dlist"><dl>
<dt class="hdlist1">
--active-branches=<n>
</dt>
<dd>
<p>
Maximum number of branches to maintain active at once.
See “Memory Utilization” below for details. Default is 5.
</p>
</dd>
<dt class="hdlist1">
--big-file-threshold=<n>
</dt>
<dd>
<p>
Maximum size of a blob that fast-import will attempt to
create a delta for, expressed in bytes. The default is 512m
(512 MiB). Some importers may wish to lower this on systems
with constrained memory.
</p>
</dd>
<dt class="hdlist1">
--depth=<n>
</dt>
<dd>
<p>
Maximum delta depth, for blob and tree deltification.
Default is 50.
</p>
</dd>
<dt class="hdlist1">
--export-pack-edges=<file>
</dt>
<dd>
<p>
After creating a packfile, print a line of data to
<file> listing the filename of the packfile and the last
commit on each branch that was written to that packfile.
This information may be useful after importing projects
whose total object set exceeds the 4 GiB packfile limit,
as these commits can be used as edge points during calls
to <em>git pack-objects</em>.
</p>
</dd>
<dt class="hdlist1">
--max-pack-size=<n>
</dt>
<dd>
<p>
Maximum size of each output packfile.
The default is unlimited.
</p>
</dd>
<dt class="hdlist1">
fastimport.unpackLimit
</dt>
<dd>
<p>
See <a href="git-config.html">git-config(1)</a>
</p>
</dd>
</dl></div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_performance">PERFORMANCE</h2>
<div class="sectionbody">
<div class="paragraph"><p>The design of fast-import allows it to import large projects in a minimum
amount of memory usage and processing time. Assuming the frontend
is able to keep up with fast-import and feed it a constant stream of data,
import times for projects holding 10+ years of history and containing
100,000+ individual commits are generally completed in just 1-2
hours on quite modest (~$2,000 USD) hardware.</p></div>
<div class="paragraph"><p>Most bottlenecks appear to be in foreign source data access (the
source just cannot extract revisions fast enough) or disk IO (fast-import
writes as fast as the disk will take the data). Imports will run
faster if the source data is stored on a different drive than the
destination Git repository (due to less IO contention).</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_development_cost">DEVELOPMENT COST</h2>
<div class="sectionbody">
<div class="paragraph"><p>A typical frontend for fast-import tends to weigh in at approximately 200
lines of Perl/Python/Ruby code. Most developers have been able to
create working importers in just a couple of hours, even though it
is their first exposure to fast-import, and sometimes even to Git. This is
an ideal situation, given that most conversion tools are throw-away
(use once, and never look back).</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_parallel_operation">PARALLEL OPERATION</h2>
<div class="sectionbody">
<div class="paragraph"><p>Like <em>git push</em> or <em>git fetch</em>, imports handled by fast-import are safe to
run alongside parallel <code>git repack -a -d</code> or <code>git gc</code> invocations,
or any other Git operation (including <em>git prune</em>, as loose objects
are never used by fast-import).</p></div>
<div class="paragraph"><p>fast-import does not lock the branch or tag refs it is actively importing.
After the import, during its ref update phase, fast-import tests each
existing branch ref to verify the update will be a fast-forward
update (the commit stored in the ref is contained in the new
history of the commit to be written). If the update is not a
fast-forward update, fast-import will skip updating that ref and instead
prints a warning message. fast-import will always attempt to update all
branch refs, and does not stop on the first failure.</p></div>
<div class="paragraph"><p>Branch updates can be forced with --force, but it’s recommended that
this only be used on an otherwise quiet repository. Using --force
is not necessary for an initial import into an empty repository.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_technical_discussion">TECHNICAL DISCUSSION</h2>
<div class="sectionbody">
<div class="paragraph"><p>fast-import tracks a set of branches in memory. Any branch can be created
or modified at any point during the import process by sending a
<code>commit</code> command on the input stream. This design allows a frontend
program to process an unlimited number of branches simultaneously,
generating commits in the order they are available from the source
data. It also simplifies the frontend programs considerably.</p></div>
<div class="paragraph"><p>fast-import does not use or alter the current working directory, or any
file within it. (It does however update the current Git repository,
as referenced by <code>GIT_DIR</code>.) Therefore an import frontend may use
the working directory for its own purposes, such as extracting file
revisions from the foreign source. This ignorance of the working
directory also allows fast-import to run very quickly, as it does not
need to perform any costly file update operations when switching
between branches.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_input_format">INPUT FORMAT</h2>
<div class="sectionbody">
<div class="paragraph"><p>With the exception of raw file data (which Git does not interpret)
the fast-import input format is text (ASCII) based. This text based
format simplifies development and debugging of frontend programs,
especially when a higher level language such as Perl, Python or
Ruby is being used.</p></div>
<div class="paragraph"><p>fast-import is very strict about its input. Where we say SP below we mean
<strong>exactly</strong> one space. Likewise LF means one (and only one) linefeed
and HT one (and only one) horizontal tab.
Supplying additional whitespace characters will cause unexpected
results, such as branch names or file names with leading or trailing
spaces in their name, or early termination of fast-import when it encounters
unexpected input.</p></div>
<div class="sect2">
<h3 id="_stream_comments">Stream Comments</h3>
<div class="paragraph"><p>To aid in debugging frontends fast-import ignores any line that
begins with <code>#</code> (ASCII pound/hash) up to and including the line
ending <code>LF</code>. A comment line may contain any sequence of bytes
that does not contain an LF and therefore may be used to include
any detailed debugging information that might be specific to the
frontend and useful when inspecting a fast-import data stream.</p></div>
</div>
<div class="sect2">
<h3 id="_date_formats">Date Formats</h3>
<div class="paragraph"><p>The following date formats are supported. A frontend should select
the format it will use for this import by passing the format name
in the --date-format=<fmt> command-line option.</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
<code>raw</code>
</dt>
<dd>
<p>
This is the Git native format and is <code><time> SP <offutc></code>.
It is also fast-import’s default format, if --date-format was
not specified.
</p>
<div class="paragraph"><p>The time of the event is specified by <code><time></code> as the number of
seconds since the UNIX epoch (midnight, Jan 1, 1970, UTC) and is
written as an ASCII decimal integer.</p></div>
<div class="paragraph"><p>The local offset is specified by <code><offutc></code> as a positive or negative
offset from UTC. For example EST (which is 5 hours behind UTC)
would be expressed in <code><tz></code> by “-0500” while UTC is “+0000”.
The local offset does not affect <code><time></code>; it is used only as an
advisement to help formatting routines display the timestamp.</p></div>
<div class="paragraph"><p>If the local offset is not available in the source material, use
“+0000”, or the most common local offset. For example many
organizations have a CVS repository which has only ever been accessed
by users who are located in the same location and time zone. In this
case a reasonable offset from UTC could be assumed.</p></div>
<div class="paragraph"><p>Unlike the <code>rfc2822</code> format, this format is very strict. Any
variation in formatting will cause fast-import to reject the value,
and some sanity checks on the numeric values may also be performed.</p></div>
</dd>
<dt class="hdlist1">
<code>raw-permissive</code>
</dt>
<dd>
<p>
This is the same as <code>raw</code> except that no sanity checks on
the numeric epoch and local offset are performed. This can
be useful when trying to filter or import an existing history
with e.g. bogus timezone values.
</p>
</dd>
<dt class="hdlist1">
<code>rfc2822</code>
</dt>
<dd>
<p>
This is the standard date format as described by RFC 2822.
</p>
<div class="paragraph"><p>An example value is “Tue Feb 6 11:22:18 2007 -0500”. The Git
parser is accurate, but a little on the lenient side. It is the
same parser used by <em>git am</em> when applying patches
received from email.</p></div>
<div class="paragraph"><p>Some malformed strings may be accepted as valid dates. In some of
these cases Git will still be able to obtain the correct date from
the malformed string. There are also some types of malformed
strings which Git will parse wrong, and yet consider valid.
Seriously malformed strings will be rejected.</p></div>
<div class="paragraph"><p>Unlike the <code>raw</code> format above, the time zone/UTC offset information
contained in an RFC 2822 date string is used to adjust the date
value to UTC prior to storage. Therefore it is important that
this information be as accurate as possible.</p></div>
<div class="paragraph"><p>If the source material uses RFC 2822 style dates,
the frontend should let fast-import handle the parsing and conversion
(rather than attempting to do it itself) as the Git parser has
been well tested in the wild.</p></div>
<div class="paragraph"><p>Frontends should prefer the <code>raw</code> format if the source material
already uses UNIX-epoch format, can be coaxed to give dates in that
format, or its format is easily convertible to it, as there is no
ambiguity in parsing.</p></div>
</dd>
<dt class="hdlist1">
<code>now</code>
</dt>
<dd>
<p>
Always use the current time and time zone. The literal
<code>now</code> must always be supplied for <code><when></code>.
</p>
<div class="paragraph"><p>This is a toy format. The current time and time zone of this system
is always copied into the identity string at the time it is being
created by fast-import. There is no way to specify a different time or
time zone.</p></div>
<div class="paragraph"><p>This particular format is supplied as it’s short to implement and
may be useful to a process that wants to create a new commit
right now, without needing to use a working directory or
<em>git update-index</em>.</p></div>
<div class="paragraph"><p>If separate <code>author</code> and <code>committer</code> commands are used in a <code>commit</code>
the timestamps may not match, as the system clock will be polled
twice (once for each command). The only way to ensure that both
author and committer identity information has the same timestamp
is to omit <code>author</code> (thus copying from <code>committer</code>) or to use a
date format other than <code>now</code>.</p></div>
</dd>
</dl></div>
</div>
<div class="sect2">
<h3 id="_commands">Commands</h3>
<div class="paragraph"><p>fast-import accepts several commands to update the current repository
and control the current import process. More detailed discussion
(with examples) of each command follows later.</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
<code>commit</code>
</dt>
<dd>
<p>
Creates a new branch or updates an existing branch by
creating a new commit and updating the branch to point at
the newly created commit.
</p>
</dd>
<dt class="hdlist1">
<code>tag</code>
</dt>
<dd>
<p>
Creates an annotated tag object from an existing commit or
branch. Lightweight tags are not supported by this command,
as they are not recommended for recording meaningful points
in time.
</p>
</dd>
<dt class="hdlist1">
<code>reset</code>
</dt>
<dd>
<p>
Reset an existing branch (or a new branch) to a specific
revision. This command must be used to change a branch to
a specific revision without making a commit on it.
</p>
</dd>
<dt class="hdlist1">
<code>blob</code>
</dt>
<dd>
<p>
Convert raw file data into a blob, for future use in a
<code>commit</code> command. This command is optional and is not
needed to perform an import.
</p>
</dd>
<dt class="hdlist1">
<code>alias</code>
</dt>
<dd>
<p>
Record that a mark refers to a given object without first
creating any new object. Using --import-marks and referring
to missing marks will cause fast-import to fail, so aliases
can provide a way to set otherwise pruned commits to a valid
value (e.g. the nearest non-pruned ancestor).
</p>
</dd>
<dt class="hdlist1">
<code>checkpoint</code>
</dt>
<dd>
<p>
Forces fast-import to close the current packfile, generate its
unique SHA-1 checksum and index, and start a new packfile.
This command is optional and is not needed to perform
an import.
</p>
</dd>
<dt class="hdlist1">
<code>progress</code>
</dt>
<dd>
<p>
Causes fast-import to echo the entire line to its own
standard output. This command is optional and is not needed
to perform an import.
</p>
</dd>
<dt class="hdlist1">
<code>done</code>
</dt>
<dd>
<p>
Marks the end of the stream. This command is optional
unless the <code>done</code> feature was requested using the
<code>--done</code> command-line option or <code>feature done</code> command.
</p>
</dd>
<dt class="hdlist1">
<code>get-mark</code>
</dt>
<dd>
<p>
Causes fast-import to print the SHA-1 corresponding to a mark
to the file descriptor set with <code>--cat-blob-fd</code>, or <code>stdout</code> if
unspecified.
</p>
</dd>
<dt class="hdlist1">
<code>cat-blob</code>
</dt>
<dd>
<p>
Causes fast-import to print a blob in <em>cat-file --batch</em>
format to the file descriptor set with <code>--cat-blob-fd</code> or
<code>stdout</code> if unspecified.
</p>
</dd>
<dt class="hdlist1">
<code>ls</code>
</dt>
<dd>
<p>
Causes fast-import to print a line describing a directory
entry in <em>ls-tree</em> format to the file descriptor set with
<code>--cat-blob-fd</code> or <code>stdout</code> if unspecified.
</p>
</dd>
<dt class="hdlist1">
<code>feature</code>
</dt>
<dd>
<p>
Enable the specified feature. This requires that fast-import
supports the specified feature, and aborts if it does not.
</p>
</dd>
<dt class="hdlist1">
<code>option</code>
</dt>
<dd>
<p>
Specify any of the options listed under OPTIONS that do not
change stream semantic to suit the frontend’s needs. This
command is optional and is not needed to perform an import.
</p>
</dd>
</dl></div>
</div>
<div class="sect2">
<h3 id="_code_commit_code"><code>commit</code></h3>
<div class="paragraph"><p>Create or update a branch with a new commit, recording one logical
change to the project.</p></div>
<div class="literalblock">
<div class="content">
<pre><code> 'commit' SP <ref> LF
mark?
original-oid?
('author' (SP <name>)? SP LT <email> GT SP <when> LF)?
'committer' (SP <name>)? SP LT <email> GT SP <when> LF
('encoding' SP <encoding>)?
data
('from' SP <commit-ish> LF)?
('merge' SP <commit-ish> LF)*
(filemodify | filedelete | filecopy | filerename | filedeleteall | notemodify)*
LF?</code></pre>
</div></div>
<div class="paragraph"><p>where <code><ref></code> is the name of the branch to make the commit on.
Typically branch names are prefixed with <code>refs/heads/</code> in
Git, so importing the CVS branch symbol <code>RELENG-1_0</code> would use
<code>refs/heads/RELENG-1_0</code> for the value of <code><ref></code>. The value of
<code><ref></code> must be a valid refname in Git. As <code>LF</code> is not valid in
a Git refname, no quoting or escaping syntax is supported here.</p></div>
<div class="paragraph"><p>A <code>mark</code> command may optionally appear, requesting fast-import to save a
reference to the newly created commit for future use by the frontend
(see below for format). It is very common for frontends to mark
every commit they create, thereby allowing future branch creation
from any imported commit.</p></div>
<div class="paragraph"><p>The <code>data</code> command following <code>committer</code> must supply the commit
message (see below for <code>data</code> command syntax). To import an empty
commit message use a 0 length data. Commit messages are free-form
and are not interpreted by Git. Currently they must be encoded in
UTF-8, as fast-import does not permit other encodings to be specified.</p></div>
<div class="paragraph"><p>Zero or more <code>filemodify</code>, <code>filedelete</code>, <code>filecopy</code>, <code>filerename</code>,
<code>filedeleteall</code> and <code>notemodify</code> commands
may be included to update the contents of the branch prior to
creating the commit. These commands may be supplied in any order.
However it is recommended that a <code>filedeleteall</code> command precede
all <code>filemodify</code>, <code>filecopy</code>, <code>filerename</code> and <code>notemodify</code> commands in
the same commit, as <code>filedeleteall</code> wipes the branch clean (see below).</p></div>
<div class="paragraph"><p>The <code>LF</code> after the command is optional (it used to be required). Note
that for reasons of backward compatibility, if the commit ends with a
<code>data</code> command (i.e. it has no <code>from</code>, <code>merge</code>, <code>filemodify</code>,
<code>filedelete</code>, <code>filecopy</code>, <code>filerename</code>, <code>filedeleteall</code> or
<code>notemodify</code> commands) then two <code>LF</code> commands may appear at the end of
the command instead of just one.</p></div>
<div class="sect3">
<h4 id="_code_author_code"><code>author</code></h4>
<div class="paragraph"><p>An <code>author</code> command may optionally appear, if the author information
might differ from the committer information. If <code>author</code> is omitted
then fast-import will automatically use the committer’s information for
the author portion of the commit. See below for a description of
the fields in <code>author</code>, as they are identical to <code>committer</code>.</p></div>
</div>
<div class="sect3">
<h4 id="_code_committer_code"><code>committer</code></h4>
<div class="paragraph"><p>The <code>committer</code> command indicates who made this commit, and when
they made it.</p></div>
<div class="paragraph"><p>Here <code><name></code> is the person’s display name (for example
“Com M Itter”) and <code><email></code> is the person’s email address
(“cm@example.com”). <code>LT</code> and <code>GT</code> are the literal less-than (\x3c)
and greater-than (\x3e) symbols. These are required to delimit
the email address from the other fields in the line. Note that
<code><name></code> and <code><email></code> are free-form and may contain any sequence
of bytes, except <code>LT</code>, <code>GT</code> and <code>LF</code>. <code><name></code> is typically UTF-8 encoded.</p></div>
<div class="paragraph"><p>The time of the change is specified by <code><when></code> using the date format
that was selected by the --date-format=<fmt> command-line option.
See “Date Formats” above for the set of supported formats, and
their syntax.</p></div>
</div>
<div class="sect3">
<h4 id="_code_encoding_code"><code>encoding</code></h4>
<div class="paragraph"><p>The optional <code>encoding</code> command indicates the encoding of the commit
message. Most commits are UTF-8 and the encoding is omitted, but this
allows importing commit messages into git without first reencoding them.</p></div>
</div>
<div class="sect3">
<h4 id="_code_from_code"><code>from</code></h4>
<div class="paragraph"><p>The <code>from</code> command is used to specify the commit to initialize
this branch from. This revision will be the first ancestor of the
new commit. The state of the tree built at this commit will begin
with the state at the <code>from</code> commit, and be altered by the content
modifications in this commit.</p></div>
<div class="paragraph"><p>Omitting the <code>from</code> command in the first commit of a new branch
will cause fast-import to create that commit with no ancestor. This
tends to be desired only for the initial commit of a project.
If the frontend creates all files from scratch when making a new
branch, a <code>merge</code> command may be used instead of <code>from</code> to start
the commit with an empty tree.
Omitting the <code>from</code> command on existing branches is usually desired,
as the current commit on that branch is automatically assumed to
be the first ancestor of the new commit.</p></div>
<div class="paragraph"><p>As <code>LF</code> is not valid in a Git refname or SHA-1 expression, no
quoting or escaping syntax is supported within <code><commit-ish></code>.</p></div>
<div class="paragraph"><p>Here <code><commit-ish></code> is any of the following:</p></div>
<div class="ulist"><ul>
<li>
<p>
The name of an existing branch already in fast-import’s internal branch
table. If fast-import doesn’t know the name, it’s treated as a SHA-1
expression.
</p>
</li>
<li>
<p>
A mark reference, <code>:<idnum></code>, where <code><idnum></code> is the mark number.
</p>
<div class="paragraph"><p>The reason fast-import uses <code>:</code> to denote a mark reference is this character
is not legal in a Git branch name. The leading <code>:</code> makes it easy
to distinguish between the mark 42 (<code>:42</code>) and the branch 42 (<code>42</code>
or <code>refs/heads/42</code>), or an abbreviated SHA-1 which happened to
consist only of base-10 digits.</p></div>
<div class="paragraph"><p>Marks must be declared (via <code>mark</code>) before they can be used.</p></div>
</li>
<li>
<p>
A complete 40 byte or abbreviated commit SHA-1 in hex.
</p>
</li>
<li>
<p>
Any valid Git SHA-1 expression that resolves to a commit. See
“SPECIFYING REVISIONS” in <a href="gitrevisions.html">gitrevisions(7)</a> for details.
</p>
</li>
<li>
<p>
The special null SHA-1 (40 zeros) specifies that the branch is to be
removed.
</p>
</li>
</ul></div>
<div class="paragraph"><p>The special case of restarting an incremental import from the
current branch value should be written as:</p></div>
<div class="listingblock">
<div class="content">
<pre><code> from refs/heads/branch^0</code></pre>
</div></div>
<div class="paragraph"><p>The <code>^0</code> suffix is necessary as fast-import does not permit a branch to
start from itself, and the branch is created in memory before the
<code>from</code> command is even read from the input. Adding <code>^0</code> will force
fast-import to resolve the commit through Git’s revision parsing library,
rather than its internal branch table, thereby loading in the
existing value of the branch.</p></div>
</div>
<div class="sect3">
<h4 id="_code_merge_code"><code>merge</code></h4>
<div class="paragraph"><p>Includes one additional ancestor commit. The additional ancestry
link does not change the way the tree state is built at this commit.
If the <code>from</code> command is
omitted when creating a new branch, the first <code>merge</code> commit will be
the first ancestor of the current commit, and the branch will start
out with no files. An unlimited number of <code>merge</code> commands per
commit are permitted by fast-import, thereby establishing an n-way merge.</p></div>
<div class="paragraph"><p>Here <code><commit-ish></code> is any of the commit specification expressions
also accepted by <code>from</code> (see above).</p></div>
</div>
<div class="sect3">
<h4 id="_code_filemodify_code"><code>filemodify</code></h4>
<div class="paragraph"><p>Included in a <code>commit</code> command to add a new file or change the
content of an existing file. This command has two different means
of specifying the content of the file.</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
External data format
</dt>
<dd>
<p>
The data content for the file was already supplied by a prior
<code>blob</code> command. The frontend just needs to connect it.
</p>
<div class="literalblock">
<div class="content">
<pre><code> 'M' SP <mode> SP <dataref> SP <path> LF</code></pre>
</div></div>
<div class="paragraph"><p>Here usually <code><dataref></code> must be either a mark reference (<code>:<idnum></code>)
set by a prior <code>blob</code> command, or a full 40-byte SHA-1 of an
existing Git blob object. If <code><mode></code> is <code>040000`</code> then
<code><dataref></code> must be the full 40-byte SHA-1 of an existing
Git tree object or a mark reference set with <code>--import-marks</code>.</p></div>
</dd>
<dt class="hdlist1">
Inline data format
</dt>
<dd>
<p>
The data content for the file has not been supplied yet.
The frontend wants to supply it as part of this modify
command.
</p>
<div class="literalblock">
<div class="content">
<pre><code> 'M' SP <mode> SP 'inline' SP <path> LF
data</code></pre>
</div></div>
<div class="paragraph"><p>See below for a detailed description of the <code>data</code> command.</p></div>
</dd>
</dl></div>
<div class="paragraph"><p>In both formats <code><mode></code> is the type of file entry, specified
in octal. Git only supports the following modes:</p></div>
<div class="ulist"><ul>
<li>
<p>
<code>100644</code> or <code>644</code>: A normal (not-executable) file. The majority
of files in most projects use this mode. If in doubt, this is
what you want.
</p>
</li>
<li>
<p>
<code>100755</code> or <code>755</code>: A normal, but executable, file.
</p>
</li>
<li>
<p>
<code>120000</code>: A symlink, the content of the file will be the link target.
</p>
</li>
<li>
<p>
<code>160000</code>: A gitlink, SHA-1 of the object refers to a commit in
another repository. Git links can only be specified either by SHA or through
a commit mark. They are used to implement submodules.
</p>
</li>
<li>
<p>
<code>040000</code>: A subdirectory. Subdirectories can only be specified by
SHA or through a tree mark set with <code>--import-marks</code>.
</p>
</li>
</ul></div>
<div class="paragraph"><p>In both formats <code><path></code> is the complete path of the file to be added
(if not already existing) or modified (if already existing).</p></div>
<div class="paragraph"><p>A <code><path></code> can be written as unquoted bytes or a C-style quoted string.</p></div>
<div class="paragraph"><p>When a <code><path></code> does not start with a double quote (<code>"</code>), it is an
unquoted string and is parsed as literal bytes without any escape
sequences. However, if the filename contains <code>LF</code> or starts with double
quote, it cannot be represented as an unquoted string and must be
quoted. Additionally, the source <code><path></code> in <code>filecopy</code> or <code>filerename</code>
must be quoted if it contains SP.</p></div>
<div class="paragraph"><p>When a <code><path></code> starts with a double quote (<code>"</code>), it is a C-style quoted
string, where the complete filename is enclosed in a pair of double
quotes and escape sequences are used. Certain characters must be escaped
by preceding them with a backslash: <code>LF</code> is written as <code>\n</code>, backslash
as <code>\\</code>, and double quote as <code>\"</code>. Some characters may optionally be
written with escape sequences: <code>\a</code> for bell, <code>\b</code> for backspace, <code>\f</code>
for form feed, <code>\n</code> for line feed, <code>\r</code> for carriage return, <code>\t</code> for
horizontal tab, and <code>\v</code> for vertical tab. Any byte can be written with
3-digit octal codes (e.g., <code>\033</code>). All filenames can be represented as
quoted strings.</p></div>
<div class="paragraph"><p>A <code><path></code> must use UNIX-style directory separators (forward slash <code>/</code>)
and its value must be in canonical form. That is it must not:</p></div>
<div class="ulist"><ul>
<li>
<p>
contain an empty directory component (e.g. <code>foo//bar</code> is invalid),
</p>
</li>
<li>
<p>
end with a directory separator (e.g. <code>foo/</code> is invalid),
</p>
</li>
<li>
<p>
start with a directory separator (e.g. <code>/foo</code> is invalid),
</p>
</li>
<li>
<p>
contain the special component <code>.</code> or <code>..</code> (e.g. <code>foo/./bar</code> and
<code>foo/../bar</code> are invalid).
</p>
</li>
</ul></div>
<div class="paragraph"><p>The root of the tree can be represented by an empty string as <code><path></code>.</p></div>
<div class="paragraph"><p><code><path></code> cannot contain NUL, either literally or escaped as <code>\000</code>.
It is recommended that <code><path></code> always be encoded using UTF-8.</p></div>
</div>
<div class="sect3">
<h4 id="_code_filedelete_code"><code>filedelete</code></h4>
<div class="paragraph"><p>Included in a <code>commit</code> command to remove a file or recursively
delete an entire directory from the branch. If the file or directory
removal makes its parent directory empty, the parent directory will
be automatically removed too. This cascades up the tree until the
first non-empty directory or the root is reached.</p></div>
<div class="literalblock">
<div class="content">
<pre><code> 'D' SP <path> LF</code></pre>
</div></div>
<div class="paragraph"><p>here <code><path></code> is the complete path of the file or subdirectory to
be removed from the branch.
See <code>filemodify</code> above for a detailed description of <code><path></code>.</p></div>
</div>
<div class="sect3">
<h4 id="_code_filecopy_code"><code>filecopy</code></h4>
<div class="paragraph"><p>Recursively copies an existing file or subdirectory to a different
location within the branch. The existing file or directory must
exist. If the destination exists it will be completely replaced
by the content copied from the source.</p></div>
<div class="literalblock">
<div class="content">
<pre><code> 'C' SP <path> SP <path> LF</code></pre>
</div></div>
<div class="paragraph"><p>here the first <code><path></code> is the source location and the second
<code><path></code> is the destination. See <code>filemodify</code> above for a detailed
description of what <code><path></code> may look like. To use a source path
that contains SP the path must be quoted.</p></div>
<div class="paragraph"><p>A <code>filecopy</code> command takes effect immediately. Once the source
location has been copied to the destination any future commands
applied to the source location will not impact the destination of
the copy.</p></div>
</div>
<div class="sect3">
<h4 id="_code_filerename_code"><code>filerename</code></h4>
<div class="paragraph"><p>Renames an existing file or subdirectory to a different location
within the branch. The existing file or directory must exist. If
the destination exists it will be replaced by the source directory.</p></div>
<div class="literalblock">
<div class="content">
<pre><code> 'R' SP <path> SP <path> LF</code></pre>
</div></div>
<div class="paragraph"><p>here the first <code><path></code> is the source location and the second
<code><path></code> is the destination. See <code>filemodify</code> above for a detailed
description of what <code><path></code> may look like. To use a source path
that contains SP the path must be quoted.</p></div>
<div class="paragraph"><p>A <code>filerename</code> command takes effect immediately. Once the source
location has been renamed to the destination any future commands
applied to the source location will create new files there and not
impact the destination of the rename.</p></div>
<div class="paragraph"><p>Note that a <code>filerename</code> is the same as a <code>filecopy</code> followed by a
<code>filedelete</code> of the source location. There is a slight performance
advantage to using <code>filerename</code>, but the advantage is so small
that it is never worth trying to convert a delete/add pair in
source material into a rename for fast-import. This <code>filerename</code>
command is provided just to simplify frontends that already have
rename information and don’t want bother with decomposing it into a
<code>filecopy</code> followed by a <code>filedelete</code>.</p></div>
</div>
<div class="sect3">
<h4 id="_code_filedeleteall_code"><code>filedeleteall</code></h4>
<div class="paragraph"><p>Included in a <code>commit</code> command to remove all files (and also all
directories) from the branch. This command resets the internal
branch structure to have no files in it, allowing the frontend
to subsequently add all interesting files from scratch.</p></div>
<div class="literalblock">
<div class="content">
<pre><code> 'deleteall' LF</code></pre>
</div></div>
<div class="paragraph"><p>This command is extremely useful if the frontend does not know
(or does not care to know) what files are currently on the branch,
and therefore cannot generate the proper <code>filedelete</code> commands to
update the content.</p></div>
<div class="paragraph"><p>Issuing a <code>filedeleteall</code> followed by the needed <code>filemodify</code>
commands to set the correct content will produce the same results
as sending only the needed <code>filemodify</code> and <code>filedelete</code> commands.
The <code>filedeleteall</code> approach may however require fast-import to use slightly
more memory per active branch (less than 1 MiB for even most large
projects); so frontends that can easily obtain only the affected
paths for a commit are encouraged to do so.</p></div>
</div>
<div class="sect3">
<h4 id="_code_notemodify_code"><code>notemodify</code></h4>
<div class="paragraph"><p>Included in a <code>commit</code> <code><notes-ref></code> command to add a new note
annotating a <code><commit-ish></code> or change this annotation contents.
Internally it is similar to filemodify 100644 on <code><commit-ish></code>
path (maybe split into subdirectories). It’s not advised to
use any other commands to write to the <code><notes-ref></code> tree except
<code>filedeleteall</code> to delete all existing notes in this tree.
This command has two different means of specifying the content
of the note.</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
External data format
</dt>
<dd>
<p>
The data content for the note was already supplied by a prior
<code>blob</code> command. The frontend just needs to connect it to the
commit that is to be annotated.
</p>
<div class="literalblock">
<div class="content">
<pre><code> 'N' SP <dataref> SP <commit-ish> LF</code></pre>
</div></div>
<div class="paragraph"><p>Here <code><dataref></code> can be either a mark reference (<code>:<idnum></code>)
set by a prior <code>blob</code> command, or a full 40-byte SHA-1 of an
existing Git blob object.</p></div>
</dd>
<dt class="hdlist1">
Inline data format
</dt>
<dd>
<p>
The data content for the note has not been supplied yet.
The frontend wants to supply it as part of this modify
command.
</p>
<div class="literalblock">
<div class="content">
<pre><code> 'N' SP 'inline' SP <commit-ish> LF
data</code></pre>
</div></div>
<div class="paragraph"><p>See below for a detailed description of the <code>data</code> command.</p></div>
</dd>
</dl></div>
<div class="paragraph"><p>In both formats <code><commit-ish></code> is any of the commit specification
expressions also accepted by <code>from</code> (see above).</p></div>
</div>
</div>
<div class="sect2">
<h3 id="_code_mark_code"><code>mark</code></h3>
<div class="paragraph"><p>Arranges for fast-import to save a reference to the current object, allowing
the frontend to recall this object at a future point in time, without
knowing its SHA-1. Here the current object is the object creation
command the <code>mark</code> command appears within. This can be <code>commit</code>,
<code>tag</code>, and <code>blob</code>, but <code>commit</code> is the most common usage.</p></div>
<div class="literalblock">
<div class="content">
<pre><code> 'mark' SP ':' <idnum> LF</code></pre>
</div></div>
<div class="paragraph"><p>where <code><idnum></code> is the number assigned by the frontend to this mark.
The value of <code><idnum></code> is expressed as an ASCII decimal integer.
The value 0 is reserved and cannot be used as
a mark. Only values greater than or equal to 1 may be used as marks.</p></div>
<div class="paragraph"><p>New marks are created automatically. Existing marks can be moved
to another object simply by reusing the same <code><idnum></code> in another
<code>mark</code> command.</p></div>
</div>
<div class="sect2">
<h3 id="_code_original_oid_code"><code>original-oid</code></h3>
<div class="paragraph"><p>Provides the name of the object in the original source control system.
fast-import will simply ignore this directive, but filter processes
which operate on and modify the stream before feeding to fast-import
may have uses for this information</p></div>
<div class="literalblock">
<div class="content">
<pre><code> 'original-oid' SP <object-identifier> LF</code></pre>
</div></div>
<div class="paragraph"><p>where <code><object-identifier></code> is any string not containing LF.</p></div>
</div>
<div class="sect2">
<h3 id="_code_tag_code"><code>tag</code></h3>
<div class="paragraph"><p>Creates an annotated tag referring to a specific commit. To create
lightweight (non-annotated) tags see the <code>reset</code> command below.</p></div>
<div class="literalblock">
<div class="content">
<pre><code> 'tag' SP <name> LF
mark?
'from' SP <commit-ish> LF
original-oid?
'tagger' (SP <name>)? SP LT <email> GT SP <when> LF
data</code></pre>
</div></div>
<div class="paragraph"><p>where <code><name></code> is the name of the tag to create.</p></div>
<div class="paragraph"><p>Tag names are automatically prefixed with <code>refs/tags/</code> when stored
in Git, so importing the CVS branch symbol <code>RELENG-1_0-FINAL</code> would
use just <code>RELENG-1_0-FINAL</code> for <code><name></code>, and fast-import will write the
corresponding ref as <code>refs/tags/RELENG-1_0-FINAL</code>.</p></div>
<div class="paragraph"><p>The value of <code><name></code> must be a valid refname in Git and therefore
may contain forward slashes. As <code>LF</code> is not valid in a Git refname,
no quoting or escaping syntax is supported here.</p></div>
<div class="paragraph"><p>The <code>from</code> command is the same as in the <code>commit</code> command; see
above for details.</p></div>
<div class="paragraph"><p>The <code>tagger</code> command uses the same format as <code>committer</code> within
<code>commit</code>; again see above for details.</p></div>
<div class="paragraph"><p>The <code>data</code> command following <code>tagger</code> must supply the annotated tag
message (see below for <code>data</code> command syntax). To import an empty
tag message use a 0 length data. Tag messages are free-form and are
not interpreted by Git. Currently they must be encoded in UTF-8,
as fast-import does not permit other encodings to be specified.</p></div>
<div class="paragraph"><p>Signing annotated tags during import from within fast-import is not
supported. Trying to include your own PGP/GPG signature is not
recommended, as the frontend does not (easily) have access to the
complete set of bytes which normally goes into such a signature.
If signing is required, create lightweight tags from within fast-import with
<code>reset</code>, then create the annotated versions of those tags offline
with the standard <em>git tag</em> process.</p></div>
</div>
<div class="sect2">
<h3 id="_code_reset_code"><code>reset</code></h3>
<div class="paragraph"><p>Creates (or recreates) the named branch, optionally starting from
a specific revision. The reset command allows a frontend to issue
a new <code>from</code> command for an existing branch, or to create a new
branch from an existing commit without creating a new commit.</p></div>
<div class="literalblock">
<div class="content">
<pre><code> 'reset' SP <ref> LF
('from' SP <commit-ish> LF)?
LF?</code></pre>
</div></div>
<div class="paragraph"><p>For a detailed description of <code><ref></code> and <code><commit-ish></code> see above
under <code>commit</code> and <code>from</code>.</p></div>
<div class="paragraph"><p>The <code>LF</code> after the command is optional (it used to be required).</p></div>
<div class="paragraph"><p>The <code>reset</code> command can also be used to create lightweight
(non-annotated) tags. For example:</p></div>
<div class="exampleblock">
<div class="content">
<div class="literalblock">
<div class="content">
<pre><code>reset refs/tags/938
from :938</code></pre>
</div></div>
</div></div>
<div class="paragraph"><p>would create the lightweight tag <code>refs/tags/938</code> referring to
whatever commit mark <code>:938</code> references.</p></div>
</div>
<div class="sect2">
<h3 id="_code_blob_code"><code>blob</code></h3>
<div class="paragraph"><p>Requests writing one file revision to the packfile. The revision
is not connected to any commit; this connection must be formed in
a subsequent <code>commit</code> command by referencing the blob through an
assigned mark.</p></div>
<div class="literalblock">
<div class="content">
<pre><code> 'blob' LF
mark?
original-oid?
data</code></pre>
</div></div>
<div class="paragraph"><p>The mark command is optional here as some frontends have chosen
to generate the Git SHA-1 for the blob on their own, and feed that
directly to <code>commit</code>. This is typically more work than it’s worth
however, as marks are inexpensive to store and easy to use.</p></div>
</div>
<div class="sect2">
<h3 id="_code_data_code"><code>data</code></h3>
<div class="paragraph"><p>Supplies raw data (for use as blob/file content, commit messages, or
annotated tag messages) to fast-import. Data can be supplied using an exact
byte count or delimited with a terminating line. Real frontends
intended for production-quality conversions should always use the
exact byte count format, as it is more robust and performs better.
The delimited format is intended primarily for testing fast-import.</p></div>
<div class="paragraph"><p>Comment lines appearing within the <code><raw></code> part of <code>data</code> commands
are always taken to be part of the body of the data and are therefore
never ignored by fast-import. This makes it safe to import any
file/message content whose lines might start with <code>#</code>.</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
Exact byte count format
</dt>
<dd>
<p>
The frontend must specify the number of bytes of data.
</p>
<div class="literalblock">
<div class="content">
<pre><code> 'data' SP <count> LF
<raw> LF?</code></pre>
</div></div>
<div class="paragraph"><p>where <code><count></code> is the exact number of bytes appearing within
<code><raw></code>. The value of <code><count></code> is expressed as an ASCII decimal
integer. The <code>LF</code> on either side of <code><raw></code> is not
included in <code><count></code> and will not be included in the imported data.</p></div>
<div class="paragraph"><p>The <code>LF</code> after <code><raw></code> is optional (it used to be required) but
recommended. Always including it makes debugging a fast-import
stream easier as the next command always starts in column 0
of the next line, even if <code><raw></code> did not end with an <code>LF</code>.</p></div>
</dd>
<dt class="hdlist1">
Delimited format
</dt>
<dd>
<p>
A delimiter string is used to mark the end of the data.
fast-import will compute the length by searching for the delimiter.
This format is primarily useful for testing and is not
recommended for real data.
</p>
<div class="literalblock">
<div class="content">
<pre><code> 'data' SP '<<' <delim> LF
<raw> LF
<delim> LF
LF?</code></pre>
</div></div>
<div class="paragraph"><p>where <code><delim></code> is the chosen delimiter string. The string <code><delim></code>
must not appear on a line by itself within <code><raw></code>, as otherwise
fast-import will think the data ends earlier than it really does. The <code>LF</code>
immediately trailing <code><raw></code> is part of <code><raw></code>. This is one of
the limitations of the delimited format, it is impossible to supply
a data chunk which does not have an LF as its last byte.</p></div>
<div class="paragraph"><p>The <code>LF</code> after <code><delim> LF</code> is optional (it used to be required).</p></div>
</dd>
</dl></div>
</div>
<div class="sect2">
<h3 id="_code_alias_code"><code>alias</code></h3>
<div class="paragraph"><p>Record that a mark refers to a given object without first creating any
new object.</p></div>
<div class="literalblock">
<div class="content">
<pre><code> 'alias' LF
mark
'to' SP <commit-ish> LF
LF?</code></pre>
</div></div>
<div class="paragraph"><p>For a detailed description of <code><commit-ish></code> see above under <code>from</code>.</p></div>
</div>
<div class="sect2">
<h3 id="_code_checkpoint_code"><code>checkpoint</code></h3>
<div class="paragraph"><p>Forces fast-import to close the current packfile, start a new one, and to
save out all current branch refs, tags and marks.</p></div>
<div class="literalblock">
<div class="content">
<pre><code> 'checkpoint' LF
LF?</code></pre>
</div></div>
<div class="paragraph"><p>Note that fast-import automatically switches packfiles when the current
packfile reaches --max-pack-size, or 4 GiB, whichever limit is
smaller. During an automatic packfile switch fast-import does not update
the branch refs, tags or marks.</p></div>
<div class="paragraph"><p>As a <code>checkpoint</code> can require a significant amount of CPU time and
disk IO (to compute the overall pack SHA-1 checksum, generate the
corresponding index file, and update the refs) it can easily take
several minutes for a single <code>checkpoint</code> command to complete.</p></div>
<div class="paragraph"><p>Frontends may choose to issue checkpoints during extremely large
and long running imports, or when they need to allow another Git
process access to a branch. However given that a 30 GiB Subversion
repository can be loaded into Git through fast-import in about 3 hours,
explicit checkpointing may not be necessary.</p></div>
<div class="paragraph"><p>The <code>LF</code> after the command is optional (it used to be required).</p></div>
</div>
<div class="sect2">
<h3 id="_code_progress_code"><code>progress</code></h3>
<div class="paragraph"><p>Causes fast-import to print the entire <code>progress</code> line unmodified to
its standard output channel (file descriptor 1) when the command is
processed from the input stream. The command otherwise has no impact
on the current import, or on any of fast-import’s internal state.</p></div>
<div class="literalblock">
<div class="content">
<pre><code> 'progress' SP <any> LF
LF?</code></pre>
</div></div>
<div class="paragraph"><p>The <code><any></code> part of the command may contain any sequence of bytes
that does not contain <code>LF</code>. The <code>LF</code> after the command is optional.
Callers may wish to process the output through a tool such as sed to
remove the leading part of the line, for example:</p></div>
<div class="exampleblock">
<div class="content">
<div class="literalblock">
<div class="content">
<pre><code>frontend | git fast-import | sed 's/^progress //'</code></pre>
</div></div>
</div></div>
<div class="paragraph"><p>Placing a <code>progress</code> command immediately after a <code>checkpoint</code> will
inform the reader when the <code>checkpoint</code> has been completed and it
can safely access the refs that fast-import updated.</p></div>
</div>
<div class="sect2">
<h3 id="_code_get_mark_code"><code>get-mark</code></h3>
<div class="paragraph"><p>Causes fast-import to print the SHA-1 corresponding to a mark to
stdout or to the file descriptor previously arranged with the
<code>--cat-blob-fd</code> argument. The command otherwise has no impact on the
current import; its purpose is to retrieve SHA-1s that later commits
might want to refer to in their commit messages.</p></div>
<div class="literalblock">
<div class="content">
<pre><code> 'get-mark' SP ':' <idnum> LF</code></pre>
</div></div>
<div class="paragraph"><p>See “Responses To Commands” below for details about how to read
this output safely.</p></div>
</div>
<div class="sect2">
<h3 id="_code_cat_blob_code"><code>cat-blob</code></h3>
<div class="paragraph"><p>Causes fast-import to print a blob to a file descriptor previously
arranged with the <code>--cat-blob-fd</code> argument. The command otherwise
has no impact on the current import; its main purpose is to
retrieve blobs that may be in fast-import’s memory but not
accessible from the target repository.</p></div>
<div class="literalblock">
<div class="content">
<pre><code> 'cat-blob' SP <dataref> LF</code></pre>
</div></div>
<div class="paragraph"><p>The <code><dataref></code> can be either a mark reference (<code>:<idnum></code>)
set previously or a full 40-byte SHA-1 of a Git blob, preexisting or
ready to be written.</p></div>
<div class="paragraph"><p>Output uses the same format as <code>git cat-file --batch</code>:</p></div>
<div class="exampleblock">
<div class="content">
<div class="literalblock">
<div class="content">
<pre><code><sha1> SP 'blob' SP <size> LF
<contents> LF</code></pre>
</div></div>
</div></div>
<div class="paragraph"><p>This command can be used where a <code>filemodify</code> directive can appear,
allowing it to be used in the middle of a commit. For a <code>filemodify</code>
using an inline directive, it can also appear right before the <code>data</code>
directive.</p></div>
<div class="paragraph"><p>See “Responses To Commands” below for details about how to read
this output safely.</p></div>
</div>
<div class="sect2">
<h3 id="_code_ls_code"><code>ls</code></h3>
<div class="paragraph"><p>Prints information about the object at a path to a file descriptor
previously arranged with the <code>--cat-blob-fd</code> argument. This allows
printing a blob from the active commit (with <code>cat-blob</code>) or copying a
blob or tree from a previous commit for use in the current one (with
<code>filemodify</code>).</p></div>
<div class="paragraph"><p>The <code>ls</code> command can also be used where a <code>filemodify</code> directive can
appear, allowing it to be used in the middle of a commit.</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
Reading from the active commit
</dt>
<dd>
<p>
This form can only be used in the middle of a <code>commit</code>.
The path names a directory entry within fast-import’s
active commit. The path must be quoted in this case.
</p>
<div class="literalblock">
<div class="content">
<pre><code> 'ls' SP <path> LF</code></pre>
</div></div>
</dd>
<dt class="hdlist1">
Reading from a named tree
</dt>
<dd>
<p>
The <code><dataref></code> can be a mark reference (<code>:<idnum></code>) or the
full 40-byte SHA-1 of a Git tag, commit, or tree object,
preexisting or waiting to be written.
The path is relative to the top level of the tree
named by <code><dataref></code>.
</p>
<div class="literalblock">
<div class="content">
<pre><code> 'ls' SP <dataref> SP <path> LF</code></pre>
</div></div>
</dd>
</dl></div>
<div class="paragraph"><p>See <code>filemodify</code> above for a detailed description of <code><path></code>.</p></div>
<div class="paragraph"><p>Output uses the same format as <code>git ls-tree <tree> -- <path></code>:</p></div>
<div class="exampleblock">
<div class="content">
<div class="literalblock">
<div class="content">
<pre><code><mode> SP ('blob' | 'tree' | 'commit') SP <dataref> HT <path> LF</code></pre>
</div></div>
</div></div>
<div class="paragraph"><p>The <dataref> represents the blob, tree, or commit object at <path>
and can be used in later <em>get-mark</em>, <em>cat-blob</em>, <em>filemodify</em>, or
<em>ls</em> commands.</p></div>
<div class="paragraph"><p>If there is no file or subtree at that path, <em>git fast-import</em> will
instead report</p></div>
<div class="exampleblock">
<div class="content">
<div class="literalblock">
<div class="content">
<pre><code>missing SP <path> LF</code></pre>
</div></div>
</div></div>
<div class="paragraph"><p>See “Responses To Commands” below for details about how to read
this output safely.</p></div>
</div>
<div class="sect2">
<h3 id="_code_feature_code"><code>feature</code></h3>
<div class="paragraph"><p>Require that fast-import supports the specified feature, or abort if
it does not.</p></div>
<div class="literalblock">
<div class="content">
<pre><code> 'feature' SP <feature> ('=' <argument>)? LF</code></pre>
</div></div>
<div class="paragraph"><p>The <feature> part of the command may be any one of the following:</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
date-format
</dt>
<dt class="hdlist1">
export-marks
</dt>
<dt class="hdlist1">
relative-marks
</dt>
<dt class="hdlist1">
no-relative-marks
</dt>
<dt class="hdlist1">
force
</dt>
<dd>
<p>
Act as though the corresponding command-line option with
a leading <code>--</code> was passed on the command line
(see OPTIONS, above).
</p>
</dd>
<dt class="hdlist1">
import-marks
</dt>
<dt class="hdlist1">
import-marks-if-exists
</dt>
<dd>
<p>
Like --import-marks except in two respects: first, only one
"feature import-marks" or "feature import-marks-if-exists"
command is allowed per stream; second, an --import-marks=
or --import-marks-if-exists command-line option overrides
any of these "feature" commands in the stream; third,
"feature import-marks-if-exists" like a corresponding
command-line option silently skips a nonexistent file.
</p>
</dd>
<dt class="hdlist1">
get-mark
</dt>
<dt class="hdlist1">
cat-blob
</dt>
<dt class="hdlist1">
ls
</dt>
<dd>
<p>
Require that the backend support the <em>get-mark</em>, <em>cat-blob</em>,
or <em>ls</em> command respectively.
Versions of fast-import not supporting the specified command
will exit with a message indicating so.
This lets the import error out early with a clear message,
rather than wasting time on the early part of an import
before the unsupported command is detected.
</p>
</dd>
<dt class="hdlist1">
notes
</dt>
<dd>
<p>
Require that the backend support the <em>notemodify</em> (N)
subcommand to the <em>commit</em> command.
Versions of fast-import not supporting notes will exit
with a message indicating so.
</p>
</dd>
<dt class="hdlist1">
done
</dt>
<dd>
<p>
Error out if the stream ends without a <em>done</em> command.
Without this feature, errors causing the frontend to end
abruptly at a convenient point in the stream can go
undetected. This may occur, for example, if an import
front end dies in mid-operation without emitting SIGTERM
or SIGKILL at its subordinate git fast-import instance.
</p>
</dd>
</dl></div>
</div>
<div class="sect2">
<h3 id="_code_option_code"><code>option</code></h3>
<div class="paragraph"><p>Processes the specified option so that git fast-import behaves in a
way that suits the frontend’s needs.
Note that options specified by the frontend are overridden by any
options the user may specify to git fast-import itself.</p></div>
<div class="literalblock">
<div class="content">
<pre><code> 'option' SP <option> LF</code></pre>
</div></div>
<div class="paragraph"><p>The <code><option></code> part of the command may contain any of the options
listed in the OPTIONS section that do not change import semantics,
without the leading <code>--</code> and is treated in the same way.</p></div>
<div class="paragraph"><p>Option commands must be the first commands on the input (not counting
feature commands), to give an option command after any non-option
command is an error.</p></div>
<div class="paragraph"><p>The following command-line options change import semantics and may therefore
not be passed as option:</p></div>
<div class="ulist"><ul>
<li>
<p>
date-format
</p>
</li>
<li>
<p>
import-marks
</p>
</li>
<li>
<p>
export-marks
</p>
</li>
<li>
<p>
cat-blob-fd
</p>
</li>
<li>
<p>
force
</p>
</li>
</ul></div>
</div>
<div class="sect2">
<h3 id="_code_done_code"><code>done</code></h3>
<div class="paragraph"><p>If the <code>done</code> feature is not in use, treated as if EOF was read.
This can be used to tell fast-import to finish early.</p></div>
<div class="paragraph"><p>If the <code>--done</code> command-line option or <code>feature done</code> command is
in use, the <code>done</code> command is mandatory and marks the end of the
stream.</p></div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_responses_to_commands">RESPONSES TO COMMANDS</h2>
<div class="sectionbody">
<div class="paragraph"><p>New objects written by fast-import are not available immediately.
Most fast-import commands have no visible effect until the next
checkpoint (or completion). The frontend can send commands to
fill fast-import’s input pipe without worrying about how quickly
they will take effect, which improves performance by simplifying
scheduling.</p></div>
<div class="paragraph"><p>For some frontends, though, it is useful to be able to read back
data from the current repository as it is being updated (for
example when the source material describes objects in terms of
patches to be applied to previously imported objects). This can
be accomplished by connecting the frontend and fast-import via
bidirectional pipes:</p></div>
<div class="exampleblock">
<div class="content">
<div class="literalblock">
<div class="content">
<pre><code>mkfifo fast-import-output
frontend <fast-import-output |
git fast-import >fast-import-output</code></pre>
</div></div>
</div></div>
<div class="paragraph"><p>A frontend set up this way can use <code>progress</code>, <code>get-mark</code>, <code>ls</code>, and
<code>cat-blob</code> commands to read information from the import in progress.</p></div>
<div class="paragraph"><p>To avoid deadlock, such frontends must completely consume any
pending output from <code>progress</code>, <code>ls</code>, <code>get-mark</code>, and <code>cat-blob</code> before
performing writes to fast-import that might block.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_crash_reports">CRASH REPORTS</h2>
<div class="sectionbody">
<div class="paragraph"><p>If fast-import is supplied invalid input it will terminate with a
non-zero exit status and create a crash report in the top level of
the Git repository it was importing into. Crash reports contain
a snapshot of the internal fast-import state as well as the most
recent commands that lead up to the crash.</p></div>
<div class="paragraph"><p>All recent commands (including stream comments, file changes and
progress commands) are shown in the command history within the crash
report, but raw file data and commit messages are excluded from the
crash report. This exclusion saves space within the report file
and reduces the amount of buffering that fast-import must perform
during execution.</p></div>
<div class="paragraph"><p>After writing a crash report fast-import will close the current
packfile and export the marks table. This allows the frontend
developer to inspect the repository state and resume the import from
the point where it crashed. The modified branches and tags are not
updated during a crash, as the import did not complete successfully.
Branch and tag information can be found in the crash report and
must be applied manually if the update is needed.</p></div>
<div class="paragraph"><p>An example crash:</p></div>
<div class="exampleblock">
<div class="content">
<div class="literalblock">
<div class="content">
<pre><code>$ cat >in <<END_OF_INPUT
# my very first test commit
commit refs/heads/master
committer Shawn O. Pearce <spearce> 19283 -0400
# who is that guy anyway?
data <<EOF
this is my commit
EOF
M 644 inline .gitignore
data <<EOF
.gitignore
EOF
M 777 inline bob
END_OF_INPUT</code></pre>
</div></div>
<div class="literalblock">
<div class="content">
<pre><code>$ git fast-import <in
fatal: Corrupt mode: M 777 inline bob
fast-import: dumping crash report to .git/fast_import_crash_8434</code></pre>
</div></div>
<div class="literalblock">
<div class="content">
<pre><code>$ cat .git/fast_import_crash_8434
fast-import crash report:
fast-import process: 8434
parent process : 1391
at Sat Sep 1 00:58:12 2007</code></pre>
</div></div>
<div class="literalblock">
<div class="content">
<pre><code>fatal: Corrupt mode: M 777 inline bob</code></pre>
</div></div>
<div class="literalblock">
<div class="content">
<pre><code>Most Recent Commands Before Crash
---------------------------------
# my very first test commit
commit refs/heads/master
committer Shawn O. Pearce <spearce> 19283 -0400
# who is that guy anyway?
data <<EOF
M 644 inline .gitignore
data <<EOF
* M 777 inline bob</code></pre>
</div></div>
<div class="literalblock">
<div class="content">
<pre><code>Active Branch LRU
-----------------
active_branches = 1 cur, 5 max</code></pre>
</div></div>
<div class="literalblock">
<div class="content">
<pre><code>pos clock name
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1) 0 refs/heads/master</code></pre>
</div></div>
<div class="literalblock">
<div class="content">
<pre><code>Inactive Branches
-----------------
refs/heads/master:
status : active loaded dirty
tip commit : 0000000000000000000000000000000000000000
old tree : 0000000000000000000000000000000000000000
cur tree : 0000000000000000000000000000000000000000
commit clock: 0
last pack :</code></pre>
</div></div>
<div class="literalblock">
<div class="content">
<pre><code>-------------------
END OF CRASH REPORT</code></pre>
</div></div>
</div></div>
</div>
</div>
<div class="sect1">
<h2 id="_tips_and_tricks">TIPS AND TRICKS</h2>
<div class="sectionbody">
<div class="paragraph"><p>The following tips and tricks have been collected from various
users of fast-import, and are offered here as suggestions.</p></div>
<div class="sect2">
<h3 id="_use_one_mark_per_commit">Use One Mark Per Commit</h3>
<div class="paragraph"><p>When doing a repository conversion, use a unique mark per commit
(<code>mark :<n></code>) and supply the --export-marks option on the command
line. fast-import will dump a file which lists every mark and the Git
object SHA-1 that corresponds to it. If the frontend can tie
the marks back to the source repository, it is easy to verify the
accuracy and completeness of the import by comparing each Git
commit to the corresponding source revision.</p></div>
<div class="paragraph"><p>Coming from a system such as Perforce or Subversion, this should be
quite simple, as the fast-import mark can also be the Perforce changeset
number or the Subversion revision number.</p></div>
</div>
<div class="sect2">
<h3 id="_freely_skip_around_branches">Freely Skip Around Branches</h3>
<div class="paragraph"><p>Don’t bother trying to optimize the frontend to stick to one branch
at a time during an import. Although doing so might be slightly
faster for fast-import, it tends to increase the complexity of the frontend
code considerably.</p></div>
<div class="paragraph"><p>The branch LRU builtin to fast-import tends to behave very well, and the
cost of activating an inactive branch is so low that bouncing around
between branches has virtually no impact on import performance.</p></div>
</div>
<div class="sect2">
<h3 id="_handling_renames">Handling Renames</h3>
<div class="paragraph"><p>When importing a renamed file or directory, simply delete the old
name(s) and modify the new name(s) during the corresponding commit.
Git performs rename detection after-the-fact, rather than explicitly
during a commit.</p></div>
</div>
<div class="sect2">
<h3 id="_use_tag_fixup_branches">Use Tag Fixup Branches</h3>
<div class="paragraph"><p>Some other SCM systems let the user create a tag from multiple
files which are not from the same commit/changeset. Or to create
tags which are a subset of the files available in the repository.</p></div>
<div class="paragraph"><p>Importing these tags as-is in Git is impossible without making at
least one commit which “fixes up” the files to match the content
of the tag. Use fast-import’s <code>reset</code> command to reset a dummy branch
outside of your normal branch space to the base commit for the tag,
then commit one or more file fixup commits, and finally tag the
dummy branch.</p></div>
<div class="paragraph"><p>For example since all normal branches are stored under <code>refs/heads/</code>
name the tag fixup branch <code>TAG_FIXUP</code>. This way it is impossible for
the fixup branch used by the importer to have namespace conflicts
with real branches imported from the source (the name <code>TAG_FIXUP</code>
is not <code>refs/heads/TAG_FIXUP</code>).</p></div>
<div class="paragraph"><p>When committing fixups, consider using <code>merge</code> to connect the
commit(s) which are supplying file revisions to the fixup branch.
Doing so will allow tools such as <em>git blame</em> to track
through the real commit history and properly annotate the source
files.</p></div>
<div class="paragraph"><p>After fast-import terminates the frontend will need to do <code>rm .git/TAG_FIXUP</code>
to remove the dummy branch.</p></div>
</div>
<div class="sect2">
<h3 id="_import_now_repack_later">Import Now, Repack Later</h3>
<div class="paragraph"><p>As soon as fast-import completes the Git repository is completely valid
and ready for use. Typically this takes only a very short time,
even for considerably large projects (100,000+ commits).</p></div>
<div class="paragraph"><p>However repacking the repository is necessary to improve data
locality and access performance. It can also take hours on extremely
large projects (especially if -f and a large --window parameter is
used). Since repacking is safe to run alongside readers and writers,
run the repack in the background and let it finish when it finishes.
There is no reason to wait to explore your new Git project!</p></div>
<div class="paragraph"><p>If you choose to wait for the repack, don’t try to run benchmarks
or performance tests until repacking is completed. fast-import outputs
suboptimal packfiles that are simply never seen in real use
situations.</p></div>
</div>
<div class="sect2">
<h3 id="_repacking_historical_data">Repacking Historical Data</h3>
<div class="paragraph"><p>If you are repacking very old imported data (e.g. older than the
last year), consider expending some extra CPU time and supplying
--window=50 (or higher) when you run <em>git repack</em>.
This will take longer, but will also produce a smaller packfile.
You only need to expend the effort once, and everyone using your
project will benefit from the smaller repository.</p></div>
</div>
<div class="sect2">
<h3 id="_include_some_progress_messages">Include Some Progress Messages</h3>
<div class="paragraph"><p>Every once in a while have your frontend emit a <code>progress</code> message
to fast-import. The contents of the messages are entirely free-form,
so one suggestion would be to output the current month and year
each time the current commit date moves into the next month.
Your users will feel better knowing how much of the data stream
has been processed.</p></div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_packfile_optimization">PACKFILE OPTIMIZATION</h2>
<div class="sectionbody">
<div class="paragraph"><p>When packing a blob fast-import always attempts to deltify against the last
blob written. Unless specifically arranged for by the frontend,
this will probably not be a prior version of the same file, so the
generated delta will not be the smallest possible. The resulting
packfile will be compressed, but will not be optimal.</p></div>
<div class="paragraph"><p>Frontends which have efficient access to all revisions of a
single file (for example reading an RCS/CVS ,v file) can choose
to supply all revisions of that file as a sequence of consecutive
<code>blob</code> commands. This allows fast-import to deltify the different file
revisions against each other, saving space in the final packfile.
Marks can be used to later identify individual file revisions during
a sequence of <code>commit</code> commands.</p></div>
<div class="paragraph"><p>The packfile(s) created by fast-import do not encourage good disk access
patterns. This is caused by fast-import writing the data in the order
it is received on standard input, while Git typically organizes
data within packfiles to make the most recent (current tip) data
appear before historical data. Git also clusters commits together,
speeding up revision traversal through better cache locality.</p></div>
<div class="paragraph"><p>For this reason it is strongly recommended that users repack the
repository with <code>git repack -a -d</code> after fast-import completes, allowing
Git to reorganize the packfiles for faster data access. If blob
deltas are suboptimal (see above) then also adding the <code>-f</code> option
to force recomputation of all deltas can significantly reduce the
final packfile size (30-50% smaller can be quite typical).</p></div>
<div class="paragraph"><p>Instead of running <code>git repack</code> you can also run <code>git gc
--aggressive</code>, which will also optimize other things after an import
(e.g. pack loose refs). As noted in the "AGGRESSIVE" section in
<a href="git-gc.html">git-gc(1)</a> the <code>--aggressive</code> option will find new deltas with
the <code>-f</code> option to <a href="git-repack.html">git-repack(1)</a>. For the reasons elaborated
on above using <code>--aggressive</code> after a fast-import is one of the few
cases where it’s known to be worthwhile.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_memory_utilization">MEMORY UTILIZATION</h2>
<div class="sectionbody">
<div class="paragraph"><p>There are a number of factors which affect how much memory fast-import
requires to perform an import. Like critical sections of core
Git, fast-import uses its own memory allocators to amortize any overheads
associated with malloc. In practice fast-import tends to amortize any
malloc overheads to 0, due to its use of large block allocations.</p></div>
<div class="sect2">
<h3 id="_per_object">per object</h3>
<div class="paragraph"><p>fast-import maintains an in-memory structure for every object written in
this execution. On a 32 bit system the structure is 32 bytes,
on a 64 bit system the structure is 40 bytes (due to the larger
pointer sizes). Objects in the table are not deallocated until
fast-import terminates. Importing 2 million objects on a 32 bit system
will require approximately 64 MiB of memory.</p></div>
<div class="paragraph"><p>The object table is actually a hashtable keyed on the object name
(the unique SHA-1). This storage configuration allows fast-import to reuse
an existing or already written object and avoid writing duplicates
to the output packfile. Duplicate blobs are surprisingly common
in an import, typically due to branch merges in the source.</p></div>
</div>
<div class="sect2">
<h3 id="_per_mark">per mark</h3>
<div class="paragraph"><p>Marks are stored in a sparse array, using 1 pointer (4 bytes or 8
bytes, depending on pointer size) per mark. Although the array
is sparse, frontends are still strongly encouraged to use marks
between 1 and n, where n is the total number of marks required for
this import.</p></div>
</div>
<div class="sect2">
<h3 id="_per_branch">per branch</h3>
<div class="paragraph"><p>Branches are classified as active and inactive. The memory usage
of the two classes is significantly different.</p></div>
<div class="paragraph"><p>Inactive branches are stored in a structure which uses 96 or 120
bytes (32 bit or 64 bit systems, respectively), plus the length of
the branch name (typically under 200 bytes), per branch. fast-import will
easily handle as many as 10,000 inactive branches in under 2 MiB
of memory.</p></div>
<div class="paragraph"><p>Active branches have the same overhead as inactive branches, but
also contain copies of every tree that has been recently modified on
that branch. If subtree <code>include</code> has not been modified since the
branch became active, its contents will not be loaded into memory,
but if subtree <code>src</code> has been modified by a commit since the branch
became active, then its contents will be loaded in memory.</p></div>
<div class="paragraph"><p>As active branches store metadata about the files contained on that
branch, their in-memory storage size can grow to a considerable size
(see below).</p></div>
<div class="paragraph"><p>fast-import automatically moves active branches to inactive status based on
a simple least-recently-used algorithm. The LRU chain is updated on
each <code>commit</code> command. The maximum number of active branches can be
increased or decreased on the command line with --active-branches=.</p></div>
</div>
<div class="sect2">
<h3 id="_per_active_tree">per active tree</h3>
<div class="paragraph"><p>Trees (aka directories) use just 12 bytes of memory on top of the
memory required for their entries (see “per active file” below).
The cost of a tree is virtually 0, as its overhead amortizes out
over the individual file entries.</p></div>
</div>
<div class="sect2">
<h3 id="_per_active_file_entry">per active file entry</h3>
<div class="paragraph"><p>Files (and pointers to subtrees) within active trees require 52 or 64
bytes (32/64 bit platforms) per entry. To conserve space, file and
tree names are pooled in a common string table, allowing the filename
“Makefile” to use just 16 bytes (after including the string header
overhead) no matter how many times it occurs within the project.</p></div>
<div class="paragraph"><p>The active branch LRU, when coupled with the filename string pool
and lazy loading of subtrees, allows fast-import to efficiently import
projects with 2,000+ branches and 45,114+ files in a very limited
memory footprint (less than 2.7 MiB per active branch).</p></div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_signals">SIGNALS</h2>
<div class="sectionbody">
<div class="paragraph"><p>Sending <strong>SIGUSR1</strong> to the <em>git fast-import</em> process ends the current
packfile early, simulating a <code>checkpoint</code> command. The impatient
operator can use this facility to peek at the objects and refs from an
import in progress, at the cost of some added running time and worse
compression.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_configuration">CONFIGURATION</h2>
<div class="sectionbody">
<div class="paragraph"><p>Everything below this line in this section is selectively included
from the <a href="git-config.html">git-config(1)</a> documentation. The content is the same
as what’s found there:</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
fastimport.unpackLimit
</dt>
<dd>
<p>
If the number of objects imported by <a href="git-fast-import.html">git-fast-import(1)</a>
is below this limit, then the objects will be unpacked into
loose object files. However, if the number of imported objects
equals or exceeds this limit, then the pack will be stored as a
pack. Storing the pack from a fast-import can make the import
operation complete faster, especially on slow filesystems. If
not set, the value of <code>transfer.unpackLimit</code> is used instead.
</p>
</dd>
</dl></div>
</div>
</div>
<div class="sect1">
<h2 id="_see_also">SEE ALSO</h2>
<div class="sectionbody">
<div class="paragraph"><p><a href="git-fast-export.html">git-fast-export(1)</a></p></div>
</div>
</div>
<div class="sect1">
<h2 id="_git">GIT</h2>
<div class="sectionbody">
<div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
</div>
</div>
</div>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
Last updated
2024-04-23 14:40:04 PDT
</div>
</div>
</body>
</html>
|
