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
|
\input texinfo
@setfilename tlbuild.info
@set version 2018
@set month-year February 2018
@set mytitle Building @TeX{} Live (@value{version})
@settitle @value{mytitle}
@macro TL
@TeX{}@tie{}Live
@end macro
@copying
This file documents the @TL{} build system and more.
@noindent
Copyright @copyright{} 2016--2018 Karl Berry.@*
Copyright @copyright{} 2013--2015 Karl Berry & Peter Breitenlohner.
Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
preserved on all copies.
@ignore
Permission is granted to process this file through TeX and print the
results, provided the printed document carries a copying permission
notice identical to this one except for the removal of this paragraph
(this paragraph not being relevant to the printed manual).
@end ignore
Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided that the
entire resulting derived work is distributed under the terms of a
permission notice identical to this one.
Permission is granted to copy and distribute translations of this manual
into another language, under the above conditions for modified versions,
except that this permission notice may be stated in a translation
approved by the @TeX{} Users Group.
@end copying
@c Put everything in one index (arbitrarily chosen to be the concept index).
@syncodeindex fn cp
@syncodeindex ky cp
@syncodeindex pg cp
@syncodeindex tp cp
@syncodeindex vr cp
@dircategory TeX
@direntry
* TLbuild: (tlbuild). TeX Live configuration and development.
@end direntry
@dircategory Individual utilities
@direntry
* install-tl:: Installing TeX Live.
* tlmgr:: Managing TeX Live.
@end direntry
@titlepage
@title @value{mytitle}
@subtitle @value{version} release
@subtitle @value{month-year}
@author Peter Breitenlohner
@author Karl Berry
@author @url{http://tug.org/texlive}
@page
@vskip 0pt plus 1filll
@insertcopying
@end titlepage
@shortcontents
@contents
@ifnottex
@node Top
@top @value{mytitle}
For an overview of this manual, @pxref{Introduction}.
@menu
* Introduction:: About this manual.
* Overview of build system:: The @TL{} build system.
* Prerequisites:: Requirements for building @TL{}.
* Building:: The overall build process.
* Installing:: How and where installation happens (or not).
* Layout and infrastructure:: Autoconf macros, etc., in detail.
* Configure options:: List of all configure options.
* Cross compilation:: Building on host X for target Y.
* Coding conventions:: Conventions to follow.
* Continuous integration:: Automated build testing.
* install-tl:: The @TL{} installer.
* tlmgr:: The native @TL{} package manager.
* Index:: General index.
@end menu
@end ifnottex
@node Introduction
@chapter Introduction
@cindex introduction
This manual (dated @value{month-year}) corresponds to the @TL{}
@value{version} release.
This manual is aimed at system installers and programmers, and focuses
on how to configure, build, and develop the @TL{} (TL) sources. It is
also available as plain text files in the source tree:
@file{source/README.*}.
The @file{source/README} file in the TL source tree provides the
maximally-terse information for doing a build, and portability
information for different systems, along with
@file{source/doc/README.solaris}.
For information on acquiring the TL sources, see
@url{http://tug.org/texlive/svn}.
This manual does not duplicate the (primarily user-level) information
found in other TL documentation resources, such as:
@itemize
@item The @TL{} web pages: @url{http://tug.org/texlive}.
@item The web page with an overview of how to build the binaries which
are distributed with @TL{}: @url{http://tug.org/texlive/build.html}.
@item The @TL{} user manual: @url{http://tug.org/texlive/doc.html}, or
run @code{texdoc texlive}.
@item Other @TeX{}-related Texinfo manuals (@pxref{,,,web2c, Web2c},
@ref{,,,kpathsea, Kpathsea}, etc.):
@url{http://tug.org/texinfohtml/}, or check the @samp{TeX} category in
the GNU Info system.
@item Package documentation:
@url{http://tug.org/texlive/Contents/live/doc.html}, or the
@file{doc.html} file at the top level of the installed TL.
@end itemize
As an exception, the full documentation for @code{install-tl} and
@code{tlmgr} is included here, just because it is convenient to do so.
The same text is available online (linked from
@url{http://tug.org/texlive/doc.html}, or by invoking the program with
@samp{--help} (or look at the end of the source).
@c The first word of the chapter/section title here is used to
@c construct the README.* filenames, so choose well. (Or hack the script.)
@node Overview of build system
@chapter Overview of build system
@cindex build system, design of
@cindex Autoconf
@cindex Automake
@cindex Libtool
@cindex tests, running
The @TL{} build system was redesigned in 2009, consistently using
Autoconf, Automake, and Libtool. Thus@*@ @ @ @code{configure &&
make && make check && make install}@*or the basically-equivalent
top-level @code{Build} script suffice to build and install the TL
programs. The @code{make check} clause performs various tests of the
generated programs---not strictly required but strongly recommended.
Running @code{configure --help} will display a comprehensive list of
all @code{configure} options.
The main components of the TL build system are:
@table @file
@item libs/@var{lib}
Generic libraries.
@item texk/@var{lib}
@TeX{}-specific libraries in subdirectories, notably
@var{lib}=@code{kpathsea}. (The other one is @file{texk/ptexenc}.)
@item texk/@var{prog}
@TeX{}-specific programs (that use Kpathsea).
@item utils/@var{prog}
Other programs (that don't use Kpathsea).
@end table
@pindex kpse-pkgs.m4
The primary design goal of the build system is modularity. Each
program and library module (or package) specifies its own requirements
and properties, such as required libraries, whether an installed
(system) version of a library can be used, @code{configure} options to
be seen at the top level, and more. An explicit list of all available
modules is kept in only one central place, namely @file{m4/kpse-pkgs.m4}.
A second, related goal is to configure and build each library before
configuring any other (program or library) module which uses that
library. This allows checking for properties and features of a
library built as part of the TL tree in much the same way as for a
system version of that library.
All generic libraries and several programs are maintained
independently. The corresponding modules use (most of) the
distributed source tree and document any modifications of that source.
All this is for the sake of simplifying both upgrading of modules and
integrating new modules into the TL build system. (Not to say that
either task is trivial.)
@node Prerequisites
@chapter Prerequisites
@cindex prerequisites for building
@cindex requirements for building
@cindex compilers, C and C++
Overall, building the @TL{} programs, when using all libraries from
the TL source tree, requires only C and C++ compilers and GNU
@code{make}. (If @code{make} from your @code{PATH} is not GNU make,
you can set @code{MAKE} in the environment to whatever is necessary.)
@cindex GNU @code{make}, required
@cindex @code{gmake}, required
@cindex FreeType
GNU @code{make} is required only because of some third-party
libraries, notably FreeType; all the TL-maintained directories (and
Automake/Autoconf output in general) should work with any reasonable
@code{make}.
However, a few programs in the tree have additional requirements:
@table @file
@item dvisvgm
@cindex @code{dvisvgm} requirement for C++11
@cindex C++11, required by @code{dvisvgm}
requires a C++11 compiler, such as gcc 4.8.1 (or later) or clang 3.3
(or later).
@item web2c
@cindex @code{perl}, required by @code{web2c}, etc.
requires @code{perl} for some tests run by @code{make check}.
@item xdvik
@itemx xpdfopen
@cindex X11, required by X clients
require X11 headers and libraries, often in ``development'' packages
that are not installed by default.
@item xetex
@cindex @code{fontconfig} library, required by @code{xetex}
@cindex @code{ApplicationServices} Mac framework, required by @code{xetex}
@cindex @code{Cocoa} Mac framework, required by @code{xetex}
requires @file{fontconfig} (again both headers and library), or, for
MacOSX only, the @code{ApplicationServices} and @code{Cocoa}
frameworks.
@item xindy
@cindex @code{clisp}, required by @code{xindy}
@cindex @code{ffcall}, required by @code{xindy}
requires GNU @code{clisp} and in addition @code{perl}, @code{latex},
and @code{pdflatex} to build the rules and/or documentation.
@end table
@noindent Lacking the required tools, building these
programs must avoided, e.g.,@*
@code{configure --without-x --disable-xetex --disable-xindy}
Modifying source files induces more requirements, as one might expect:
@itemize
@item
Modification of any @code{.y} or @code{.l} source files requires
@file{bison} or @file{flex} to updatete the corresponding C sources.
@item
Modification of the sources for @code{.info} files requires
@code{makeinfo}.
@item
Modification of any part of the build system (M4 macros,
@file{configure.ac}, @file{Makefile.am}, or their fragments) requires
GNU M4, GNU Autoconf, GNU Automake, and GNU Libtool to update the
generated files. @xref{Build system tools}.
@end itemize
If you haven't modified any source files, and infrastructure tools
such as @code{autoconf} or @code{makeinfo} are still being run, check
your timestamps---notably, @code{use-commit-times} must be set to
@code{yes} in your Subversion configuration (@pxref{Build system
tools}). Barring buggy commits, no infrastructure tools are needed to
do a normal build.
@cindex Debian installation of build prerequisites
As an example, on Debian systems the necessary build dependencies can
be installed via:
@example
apt-get install libfontconfig-dev libx11-dev libxmu-dev libxaw7-dev
@end example
@node Building
@chapter Building
@cindex building
@cindex overall build process
@pindex Build @r{script}
The top-level @file{Build} script is intended to simplify building the
binaries distributed with @TL{} itself---we call this the ``native''
TL build. It configures and makes everything in a subdirectory of the
main build tree (default @file{Work/}), installs everything in another
subdirectory (default @file{inst/}), and finally runs @code{make
check}. The exact directory and command names can be specified via
environment variables and a few leading options. All remaining
arguments (assignments or options) are passed to the @file{configure}
script. Please take a look at the @file{./Build} source file itself
for more information; it is a straightforward shell script.
@cindex source directory building, not supported
@cindex build directory, required
An alternative, and the one we will mainly discuss here, is to run
@code{configure} and @code{make} oneself in a suitable empty
subdirectory. Building in the source directory itself is not
supported (sorry).
@menu
* Build iteration:: What @code{configure} and @code{make} do.
* Build problems:: If the build fails.
* Build in parallel:: Simultaneous @code{make} processes.
* Build distribution:: Making a distribution tarball.
* Build one package:: Example of working on just one program.
@end menu
@node Build iteration
@section Build iteration
@cindex build iteration
@cindex iteration through sources, by @code{configure} and @code{make}
Running the top-level @file{configure} script configures the top level
and the subdirectories @file{libs}, @file{utils}, and @file{texk}.
Running @code{make} at the top-level first iterates over all
@TeX{}-specific libraries, and then runs @code{make} in
@file{libs}, @file{utils}, and @file{texk} to iterate over all generic
libraries, utility programs, and @TeX{}-specific programs. These
iterations consist of two steps:
@enumerate
@item
For each library or program module not yet configured, run
@code{configure}, adding the configure option @code{--disable-build}
if the module need not be built, otherwise running @code{make all}.
@item
For each library or program module that must be built, run
@code{make} for the selected target(s): @code{default} or
@code{all} to (re-)build, @code{check} to run tests, @code{install},
etc.
@end enumerate
Running the top-level @code{make} a second time iterates again over
all the library and program modules, but finds (should find) nothing
to be done unless some source files have been modified.
@node Build problems
@section Build problems
@cindex build problems
@cindex problems with build
@cindex failure to build
@vindex --no-clean Build @r{option}
If configuring or building a module fails, you should first find and fix the
problem, then perhaps remove the subdirectory for that module from the build
tree, and finally rerun the top level @code{make} (or @file{Build} with
@code{--no-clean} as its first argument).
@node Build in parallel
@section Build in parallel
@cindex building in parallel
@cindex parallel build
@cindex cache for @code{configure}
@cindex dependencies, with several output files
@vindex -j make @r{option}
The TL build system carefully formulates dependencies as well as
@code{make} rules when a tool (such as @code{tangle}, @code{ctangle},
or @code{convert}) creates several output files. This allows for
parallel builds (@code{make -j @var{n}} with @math{@var{n}>1} or even
@code{make -j}) that can considerably speed up the TL build.
@cindex cache file, for @code{configure}
@vindex -C configure @r{option}
Incidentally, a noticeable speed-up can also be (independently) gained
by using a configure cache file, i.e., with the option @code{-C}
(recommended).
@node Build distribution
@section Build distribution
@cindex building a distribution
@cindex distribution tarball, making
@cindex @code{dist} and @code{distcheck} targets for @code{make}
Running @code{make dist} at the top level creates a tarball
@file{tex-live-@var{yyyy}-@var{mm}-@var{dd}.tar.xz} from the TL source
tree. Running @code{make distcheck} also verifies that this tarball
suffices to build and install all of TL.
This is useful for checking consistency of the source tree and
Makefiles, but the result is not a complete or even usable @TeX{}
system, since all the support files are lacking; @pxref{Installing}.
@node Build one package
@section Build one package
@cindex build one package
@cindex one package, building
@vindex --disable-all-packages
@cindex build on demand
To build one package, the basic idea is to use the @code{configure}
option @code{--disable-all-pkgs} (@pxref{@code{--disable-all-pkgs}}).
Then all program and library modules are configured but none are made.
However, the @file{Makefile}s still contain all build rules and
dependencies and can be invoked to build an individual program or
library and causes to first build any required libraries.
This ``build-on-demand'' procedure is used, e.g., in the upstream
Lua@TeX{} repository to build Lua@TeX{}, essentially from a subset of
the complete @TL{} tree. Similarly, when, e.g., building the original
e-@TeX{} has been disabled (as it is by default), one can run
@code{make etex} (or @code{make etex.exe}) in @file{texk/web2c/} to
build e-@TeX{} (although there is no comparably simple way to install
e-@TeX{}).
If you want to work on a single program within the TL sources, this is
the recommended way to do it. Here is an example from start to
finish for working on @code{dvipdfm-x}.
@example
mkdir mydir && cd mydir # new working directory
# Get sources (@url{http://tug.org/texlive/svn})
rsync -a --delete --exclude=.svn --exclude=Work \
tug.org::tldevsrc/Build/source/ .
# Create build directory:
mkdir Work && cd Work
# Do the configure:
../configure --disable-all-pkgs --enable-dvipdfm-x \
-C CFLAGS=-g CXXFLAGS=-g >&outc
# Do the make:
make >&outm
# Test:
cd texk/dvipdfm-x
make check
@end example
Then you modify source files in @file{mydir/texk/dvipdfm-x} and rerun
@code{make} in @file{mydir/Work/texk/dvipdfm-x} to rebuild.
The second line of the @code{configure} invocation shows examples of
extra things you likely want to specify if you intend to hack the
sources (and not just build binaries): the @code{-C} speeds up
@code{configure}, and the @code{CFLAGS} and @code{CXXFLAGS} settings
eliminate compiler optimization for debugging purposes.
Of course, one should actually look at the output and check that
things are working. There are many @code{configure} options you can
tweak as desired; check the output from @code{configure --help}.
@cindex size of source tree
Finally, the above retrieves the entire TL source tree (several
hundred megabytes). It is natural to ask if this is really necessary.
Strictly speaking, the answer is no, but it is vastly more convenient
to do so. If you cut down the source tree, you must also give
additional @code{configure} flags to individually disable using system
versions of libraries, or the intricacies of the dependencies (such as
@code{teckit} requiring @code{zlib}) will have undesired side effects.
For an example, see the @code{build-pdftex.sh} script in the
@code{pdftex} development source (@url{http://pdftex.org}), which is
indeed a cut-down TL source tree.
@vindex --enable-missing @r{to ignore dependencies}
Even with @code{--disable-all-pkgs}, dependencies will be checked.
For instance, if a non-MacOSX system does not have @code{fontconfig},
Xe@TeX{} cannot be built (@pxref{Prerequisites}) and @code{configure}
will terminate. To proceed without such dependencies, specify
@code{--enable-missing} also. (Arguably this should happen
automatically.)
@vindex CC=@var{c-compiler}
@vindex CXX=@var{c++-compiler}
@vindex OBJCXX=@var{objc-compiler}
By default, the @code{gcc} compilers will be used if present;
otherwise, individual packages may use something different. You can
explicitly specify the compilers to be used with the environment
variables @code{CC}, @code{CXX}, and @code{OBJCXX}.
@node Installing
@chapter Installing
@cindex installing
This section discusses the results of @code{make install} in the
source tree.
@cindex support files, separate from build
@pindex texlive.tlpdb@r{, @TL{} database}
@pindex install-tl@r{, @TL{} installer}
@pindex plain.tex@r{, not in source tree}
The main consideration is that @code{make install} is not enough to
make a usable @TeX{} installation. Beyond the compiled binaries,
(thousands of) support files are needed; just as a first example
@file{plain.tex} is not in the source tree.
These support files are maintained completely independently and are
not present in the source tree. The best basis for dealing with them
is the @TL{} (plain text) database in
@file{Master/tlpkg/texlive.tlpdb}, and/or the @TL{} installer,
@code{install-tl}. More information is under @file{Master/tlpkg} and
at @url{http://tug.org/texlive/distro.html}.
@menu
* Installation directories:: The prefix, @code{bindir}, etc., directories.
* Linked scripts:: Scripts not maintained in the sources.
* Distro builds:: Configuring and building for OS distributions.
@end menu
@node Installation directories
@section Installation directories
@cindex installation directories
@cindex directories, for installation
@cindex paths, for installation
Running @code{make install} (or @code{make install-strip}) installs
executables in @code{@var{bindir}}, libraries in @code{@var{libdir}},
headers in @code{@var{includedir}}, general data (including ``linked
scripts'', @pxref{Linked scripts}) in
@code{@var{datarootdir}/texmf-dist}, man pages in @code{@var{mandir}},
and Info files in @code{@var{infodir}}.
The values of these directories are determined by @code{configure}
and can be specified explictly as options such as
@code{--prefix=@var{prefix}} or @code{--bindir=@var{bindir}};
otherwise, they are given by their usual Autoconf defaults:
@example
@var{prefix} /usr/local
@var{exec_prefix} @var{prefix}
@var{bindir} @var{exec_prefix}/bin
@var{libdir} @var{exec_prefix}/lib
@var{includedir} @var{prefix}/include
@var{datarootdir} @var{prefix}/share
@var{mandir} @var{datarootdir}/man
@var{infodir} @var{datarootdir}/info
@end example
@noindent except possibly modified as follows:
@itemize @bullet
@item
If the option @code{--enable-multiplatform} is given,
@code{/@var{platform}} (i.e., the canonical platform name) is appended
to @code{@var{bindir}} and @code{@var{libdir}}. This is implied for a
native TL build.
@item
@raggedright
In a native TL build, @code{@var{datarootdir}} is set to
@code{@var{prefix}}, @code{@var{infodir}} is set to
@code{@var{prefix}/texmf-dist/doc/info}, and @code{@var{mandir}} to
@code{@var{prefix}/texmf-dist/doc/man}, corresponding to the
directories used in the TL distribution.
@end raggedright
@end itemize
@noindent The top-level @file{configure} script displays all these
installation paths.
For the native TL build, the @code{Build} script leaves the binaries
in @file{./inst/bin/@var{std-platform-name}}. The new binaries are
not directly usable from that location; they need to be copied to
@file{Master/bin/@var{tl-platform}}. The other files and directories
that end up in @file{./inst/} are ignored.
@node Linked scripts
@section Linked scripts
@cindex linked scripts
@cindex scripts, linked and not maintained
@cindex symlinks, used for scripts
@cindex wrapper binary for scripts on Windows
@cindex Windows, invoking scripts on
Quite a few executables are architecture-independent shell, Perl, or
other interpreted scripts, rather than compiled binaries. A few are
maintained as part of the TL source tree, but most are maintained
elsewhere with copies under @file{texk/texlive/linked_scripts}.
These so-called @dfn{linked scripts} are installed under
@code{@var{datarootdir}/texmf-dist/scripts}; for Unix-like systems a
symbolic link is made in @code{@var{bindir}}. For example, a symlink
points from @code{@var{bindir}/ps2eps} to
@code{@var{datarootdir}/texmf-dist/scripts/ps2eps/ps2eps.pl}. For
Windows, a standard wrapper binary (e.g.,
@code{@var{bindir}/ps2eps.exe}) serves the same purpose. (The source
for the wrapper is in @file{texk/texlive/w32_wrapper}.)
One reason for this is to avoid having many copies of the same
script; a more important reason is that it guarantees the scripts will
stay in sync across the different supported operating systems.
@pindex asymptote
@pindex biber
@pindex xindy
@pindex xz
@pindex wget
Most important of all, we want the @code{@var{bindir}} resulting from
the build to be as close as possible to what is in the TL
distribution. At present, there are a few exceptions---Asymptote,
Biber, Xindy---and each one creates considerable extra work. We don't
want to add more. (See @url{http://tug.org/texlive/build.html} for
information about building those exceptions, as well as the @code{xz}
and @code{wget} programs that are used in the TL infrastructure.)
@node Distro builds
@section Distro builds
@cindex distro, building for
@cindex operating system distribution, building for
@cindex system distribution, building for
@cindex GNU/Linux distro
@cindex BSD distro
Although they use the same code base, building for the native TL
distribution as shipped by the @TeX{} user groups is typically quite
different from a ``distro'' build needed by, e.g., a full GNU/Linux or
BSD operating system distribution.
@cindex shared libraries, using vs.@: avoiding
The native TL distribution uses shared libraries only when absolutely
necessary (@file{libc}, @file{libm}, X11 libraries, and
@file{libfontconfig}). However, a distro typically wants to use as
many shared libraries as possible from elsewhere on the system,
including @TeX{}-specific libraries such as @file{libkpathsea} (even
though Kpathsea has never officially been released as a shared
library, but we digress). In addition, the installation paths will,
in general, be completely different.
Here are the @code{configure} options that distro builds are likely to
find most relevant:
@table @code
@item --disable-native-texlive-build
This must be specified to avoid interference from the many tweaks we
do for the native TL build.
@item --with-banner-add=/@var{SomeDistro}
This isn't technically required, but is strongly recommended, so your
build and your distro can be distinguished from others.
@item --enable-shared
Build shared versions of the @TeX{}-specific libraries (uses
@code{libtool}).
@item --disable-static
Do not build the static versions of the @TeX{}-specific libraries.
@item --with-system-@var{lib}
Use system versions for as many libraries @var{lib} as possible.
@code{configure --help} will give you the list of possibilities.
@item --with-@var{lib}-includes=@var{dir}
@itemx --with-@var{lib}-libdir=@var{dir}
If needed, allows you to specify where the headers/code are for the
given library @var{lib}.
@item --prefix=/usr
@itemx --prefix=/opt/TeXLive
Or whatever your convention is. The default is @file{/usr/local} and
you shouldn't install there for a distro.
@item --libdir=\$@{exec_prefix@}/lib64
May be needed for 64-bit bi-architecture (GNU/Linux) systems.
@end table
@cindex Preining, Norbert
@cindex adapting @TL{} for distros
You will need to take care of the support files mentioned above
(@pxref{Installing}), and many other issues, such as font maps,
languages, and formats, independently of the build. Norbert Preining
has written a detailed article on adapting TL for distros:
@url{http://tug.org/TUGboat/tb34-3/tb108preining-distro.pdf}. (If the
article needs updating in the future, perhaps we will merge it into
this document.)
@node Layout and infrastructure
@chapter Layout and infrastructure
@cindex layout of sources
@cindex source tree
The @TL{} source tree is the subtree rooted at @file{Build/source} of
the complete TL distribution and contains the sources for all executables
distributed by TL, as well as @code{configure} scripts and @code{make}
rules to build and install them together with some of their support
files.
@menu
* Build system tools:: Modifying infrastructure files.
* Top-level directories:: libs texk utils; am auxdir build-aux m4; doc extra.
* Autoconf macros:: TL-specific Autoconf macros.
* Library modules:: Handling libraries, with examples.
* Program modules:: Handling programs, with examples.
* Extending @TL{}:: Adding a new module.
@end menu
@node Build system tools
@section Build system tools
@cindex tools, for building
@cindex GNU tools, needed for building
@cindex infrastructure, tools needed for
As mentioned above (@pxref{Prerequisites}), a normal build requires
very little. On the other hand, if you want to modify the @TL{}
infrastructure sources, such as @file{configure.ac} or
@file{Makefile.am} files, you will need to have several additional
tools installed.
In general, the TL build system uses the latest released versions of
the GNU build tools, installed directly from the original GNU releases
(e.g., by building them with @code{configure --prefix=/usr/local/gnu}
and having @env{PATH} start with @file{/usr/local/gnu/bin}). We have
found that trying to use the versions of these tools packaged for
distros causes many extra hassles, so don't do that, tempting as it
may be.
Currently the versions we use are:
@display
@include build-tools.txt
@end display
@pindex reautoconf
@vindex --enable-maintainer-mode
These versions should be used to update the generated files (e.g.,
@file{configure} or @file{Makefile.in}) in all or parts of the TL tree
after their dependencies have been changed. This can be done
explicitly with the top-level @code{reautoconf} script or implicitly
by using the configure option @code{--enable-maintainer-mode}.
@cindex Subversion repository
@cindex timestamps, in repository
@vindex use-commit-times@r{, Subversion}
The files in the Subversion repository (see
@url{http://tug.org/texlive/svn}) are all up to date, but
unfortunately this may not be reflected by their timestamps. (For
starters, be sure to set @file{use-commit-times=yes} in
@file{~/.subversion/config} or the equivalent.)
@cindex touching files to avoid rerunning
@pindex make -t
To avoid unnecessary runs of @code{bison}, @code{flex}, or
@code{makeinfo} it may be necessary to @code{touch} the generated
(@file{.c}, @file{.h}, or @file{.info}) files. With
@code{--enable-maintainer-mode} it may also be necessary to
@code{touch} first @file{aclocal.m4}, then @file{configure} and
@file{config.h.in} (or @file{c-auto.in}), and finally all
@file{Makefile.in} files. Perhaps @code{make -t} will help.
@node Top-level directories
@section Top-level directories
@cindex directories, top-level
@cindex top-level directories
Here is a brief description of the top-level directories in the @TL{}
source tree.
As mentioned at the beginning of @pxref{Overview of build
system}, the main source directories are @file{texk/}
(@TeX{}-specific programs and libraries), @file{utils/} (additional
programs), and @file{libs/} (generic libraries).
@cindex @file{am/} top-level directory
@cindex @file{m4/} top-level directory
In addition, the top-level directories @file{am/} and @file{m4/}
contain @file{Makefile.am} fragments and Autoconf macros,
respectively, used in many places. Specifically, the file
@file{m4/kpse-pkgs.m4} contains lists of all program and library
modules; missing modules are silently ignored. (This helps in
creating cut-down source trees.)
Each module contributes fragments (in separate files) defining its
capabilities and requirements to the @file{configure.ac} scripts at
the top-level and in the subdirectories @file{libs}, @file{utils}, and
@file{texk}. The fragments from program modules supply
@code{configure} options to disable or enable building them; those
from library modules specify if an installed (system) version of that
library can be used. This ultimately determines which modules need to
be built---although all modules must be configured for the benefit of
@file{make} targets such as @code{dist} or @code{distcheck}.
@cindex @file{build-aux/} top-level directory
@pindex config.guess@r{,} config.sub, @dots{}
@cindex Gnulib, used for common files
The top-level @file{build-aux/} directory contains the common files
@file{compile}, @file{config.guess}, @file{config.sub},
@file{depcomp}, etc.@ used by most packages. These are from the GNU
Gnulib sources (@url{http://www.gnu.org/software/gnulib}), which in
turn synchronizes with the appropriate ultimate upstream repository.
There are, however, independent copies in, e.g.,
@file{libs/freetype2/freetype-*/builds/unix/}, and a few other places.
The @code{reautoconf} script does not touch those, but a TL cron job
keeps them in sync (nightly).
@cindex @file{extra/} top-level directory
The directory @file{extra/} contains things which are not part of the
TL build, but are present just for (someone's) convenience, e.g.,
is @file{epstopdf} development source is here.
@cindex @file{Work/} top-level directory
@cindex @file{inst/} top-level directory
When the top-level @file{./Build} script is used to build TL, two more
two more top-level directories appear: @file{Work/} for the build tree,
and @file{inst/} for the install tree (from @code{make install}).
These names (and everything else about @file{Build}'s operation) can
be changed by setting environment variables before running it; see the
script file.
@node Autoconf macros
@section Autoconf macros
@cindex autoconf macros
@c Texinfo macro: @ovar(ARG)
@c ARG is the name of an optional argument; this is used for
@c documentation of macro arguments (@defmac lines). Plain
@c brackets are treated specially and appear more distinct.
@macro ovar{varname}
[@var{\varname\}]
@end macro
@c @dvar(ARG, DEFAULT)
@c -------------------
@c The ARG is an optional argument, defaulting to DEFAULT. To be used
@c for macro arguments in their documentation (@defmac).
@c @macro xxdvar{varname, default}
@c @r{[}@var{\varname\} = @samp{\default\}@r{]}
@c @end macro
Here we describe some of the Autoconf macros used in several
modules--not a complete list, by any means. These general macros are
supplemented by module-specific macros in directories such as
@file{texk/dvipng/m4/}; some of those are described in @ref{Library
modules} and @pxref{Program modules}.
@menu
* Setup: General setup macros.
* Programs: Macros for programs.
* Compilers: Macros for compilers.
* Libraries: Macros for libraries.
* Flags: Macros for library and header flags.
* Windows: Macros for Windows.
@end menu
@node General setup macros
@subsection General setup macros
@cindex general setup macros
@cindex setup macros, general
@cindex macros, general setup
The TL sources use two general setup macros:
@defmac KPSE_BASIC (@var{name}, @ovar{more-options})
Initialize the basic TL infrastructure for module @var{name}:@*@ @ @
@code{AM_INIT_AUTOMAKE([foreign @var{more-options}])}@*@ @ @
@code{AM_MAINTAINER_MODE}@*@ @ @ @code{KPSE_COMPILER_WARNINGS}@*
and make sure the C compiler understands function prototypes. This is
used for all generic library and program modules.
@end defmac
@defmac KPSE_COMMON (@var{name}, @ovar{more-options})
Like @code{KPSE_BASIC} but add:@*@ @ @ @code{LT_PREREQ([2.2.6])}@*@ @
@ @code{LT_INIT([win32-dll])}@*@ @ @ @code{AC_SYS_LARGEFILE}@*@ @ @
@code{AC_FUNC_FSEEKO}@*and check for frequently used functions,
headers, types, and structures. This is used for @TeX{}-specific
modules.
@end defmac
@node Macros for programs
@subsection Macros for programs
@cindex macros, for programs
Macros for program checks:
@defmac KPSE_CHECK_LATEX
Set @code{LATEX} to the name of the first of @code{latex},
@code{elatex}, or @code{lambda} which exists in @code{PATH}, or to
@code{no} if none of them exists. Call @code{AC_SUBST} for
@code{LATEX}. The result of this test can be overridden by setting
the @code{LATEX} environment variable or the cache variable
@code{ac_cv_prog_LATEX}.
@end defmac
@defmac KPSE_CHECK_PDFLATEX
Check for @code{pdflatex} in @code{PATH} and set @code{PDFLATEX}.
@end defmac
@defmac KPSE_CHECK_PERL
Check for @code{perl} or @code{perl5} in @code{PATH} and set
@code{PERL}.
@end defmac
@defmac KPSE_PROG_LEX
Call @code{AC_PROG_LEX} and add the flag @code{-l} for @code{flex}.
@end defmac
@node Macros for compilers
@subsection Macros for compilers
@cindex macros, for compilers
Macros for compiler-related checks:
@defmac KPSE_COMPILER_WARNINGS
@vindex WARNING_C[XX]FLAGS
When using the (Objective) C/C++ compiler, set
@code{WARNING_[OBJ]C[XX]FLAGS} to suitable warning flags (depending on
the value given to or implied for @code{--enable-compiler-warnings}).
Call @code{AC_SUBST} for them. At the moment this only works for GNU
compilers, but could be extended to others if necessary.
@vindex kpse_cv_warning_cflags
This macro caches its results in the @code{kpse_cv_warning_cflags},
@dots{} variables.
@end defmac
@defmac KPSE_COMPILER_VISIBILITY
When using the C or C++ compiler, try to set
@code{VISIBILITY_C[XX]FLAGS} to flags to hide external symbols. Call
@code{AC_SUBST} for this variable. At the moment this only tests for
the compiler option @code{-fvisibility=hidden}, but that could be
extended with more checks if necessary.
@vindex kpse_cv_visibility_c[xx]flags
This macro caches its results in the @code{kpse_cv_visibility_cflags}
or @code{kpse_cv_visibility_cxxflags} variable.
@end defmac
@defmac KPSE_CXX_HACK
@cindex static linking for C++
@cindex linking C++ libraries statically
@vindex --enable-cxx-runtime-hack
@pindex libstc++@r{, statically linking}
Provide the configure option @code{--enable-cxx-runtime-hack}. If
enabled and when using @code{g++}, try to statically link with
@file{libstdc++}, somewhat improving portability of the resulting
binary.
@vindex kpse_cv_cxx_hack
This macro caches its result in the @code{kpse_cv_cxx_hack} variable.
@end defmac
@node Macros for libraries
@subsection Macros for libraries
@cindex macros, for libraries
One macro for a library check:
@defmac KPSE_LARGEFILE (@var{variable}, @ovar{extra-define})
Call @code{AC_SYS_LARGEFILE} and @code{AC_FUNC_FSEEKO} and append
suitable @code{-D} flags (optionally including
@code{-D@var{extra-define}}) to @var{variable}.
@end defmac
@node Macros for library and header flags
@subsection Macros for library and header flags
@cindex macros, for library and header flags
@cindex flags, macros for library and header
@vindex KPSE_@var{LIB}_FLAGS
Each library module @file{libs/@var{lib}} or @file{texk/@var{lib}} is
supplemented by a macro @code{KPSE_@var{LIB}_FLAGS} (all uppercase)
that provides make variables for that library. E.g., for
@file{libs/libpng}:
@defmac KPSE_LIBPNG_FLAGS
Provide the configure option @code{--with-system-libpng}. Set and
@code{AC_SUBST} @code{make} variables for modules using this library (either
an installed version or from the @TL{} tree): @code{LIBPNG_INCLUDES} for use
in @code{CPPFLAGS}, @code{LIBPNG_LIBS} for use in @code{LDADD},
@code{LIBPNG_DEPEND} for use as dependency, and @code{LIBPNG_RULE} defining
@code{make} rules to rebuild the library.
@end defmac
@defmac KPSE_ADD_FLAGS (@var{name})
Temporarily extend @code{CPPFLAGS} and @code{LIBS} with the values required
for the library module @code{@var{name}}.
@end defmac
@defmac KPSE_RESTORE_FLAGS
Restore @code{CPPFLAGS} and @code{LIBS} to their original values.
@end defmac
As an example, the @file{configure.ac} file for a hypothetical program
@file{utils/foo} using @file{libpng}, and hence @file{zlib}, would
contain
@example
KPSE_ZLIB_FLAGS
KPSE_LIBPNG_FLAGS
@end example
@noindent and its @file{Makefile.am} would be along these lines:
@example
bin_PROGRAMS = foo
AM_CPPFLAGS = $@{LIBPNG_INCLUDES@} $@{ZLIB_INCLUDES@}
foo_LDADD = $@{LIBPNG_LIBS@} $@{ZLIB_LIBS@}
foo_DEPENDENCIES = $@{ZLIB_DEPEND@} $@{LIBPNG_DEPEND@}
## Rebuild libz
@@ZLIB_RULE@@
## Rebuild libpng
@@LIBPNG_RULE@@
@end example
If it was necessary to examine whether certain @file{zlib} or
@file{libpng} features were available, @file{configure.ac} should be
continued this way:
@example
KPSE_ADD_FLAGS([zlib])
@dots{} # @r{tests for @file{zlib} features, if any}
KPSE_ADD_FLAGS([libpng])
@dots{} # @r{tests for @file{libpng} features}
KPSE_RESTORE_FLAGS # @r{restore @code{CPPFLAGS} and @code{LIBS}}
@end example
@node Macros for Windows
@subsection Macros for Windows
@cindex macros, for Windows
@cindex Windows, macros for
Windows differs in several aspects from Unix-like systems, many of
them due to the lack of symbolic links.
@defmac KPSE_CHECK_WIN32
@vindex kpse_cv_have_win32
Check if compiling for a Windows system. The result is @code{no} for
Unix-like systems (including Cygwin), @code{mingw32} for Windows with
GCC, or @code{native} for Windows with MSVC. The result is cached in
the @code{kpse_cv_have_win32} variable.
@end defmac
@defmac KPSE_COND_WIN32
@vindex WIN32@r{, Automake conditional}
Call @code{KPSE_CHECK_WIN32} and define the Automake conditional
@code{WIN32} (@code{true} if the value of @code{kpse_cv_have_win32} is
not @code{no}).
@end defmac
@defmac KPSE_COND_MINGW32
@vindex MINGW32@r{, Automake conditional}
Call @code{KPSE_COND_WIN32} and define the Automake conditional
@code{MINGW32} (@code{true} if the value of @code{kpse_cv_have_win32} is
@code{mingw32}).
@end defmac
@defmac KPSE_COND_WIN32_WRAP
@vindex WIN32_WRAP@r{, Automake conditional}
@pindex runscript.exe
Call @code{KPSE_COND_WIN32} and define the Automake conditional
@code{WIN32_WRAP} (@code{true} if the standard Windows wrapper
(@file{texk/texlive/w32_wrapper/runscript.exe}) exists. This wrapper
is used on Windows instead of symlinks for the ``linked scripts''
(@pxref{Linked scripts}).
@end defmac
@defmac KPSE_WIN32_CALL
@pindex callexe.c
Call @code{KPSE_COND_WIN32}, check if the file
@file{texk/texlive/w32_wrapper/callexe.c} exists; if it does, create a
symlink in the build tree. Compiling @file{callexe.c} with
@code{-DEXEPROG='"@var{foo}.exe"'} and installing @file{callexe.exe}
as @code{@var{bar}.exe} is used on Windows instead of a symlink
@code{@var{bar}->@var{foo}} for Unix-like systems.
@end defmac
@node Library modules
@section Library modules
@cindex library modules
@cindex modules, for libraries
Here we discuss some specifics for a few of the libraries in TL, both
for the details themselves, and as a way of illuminating the general
structure and variation.
@menu
* @code{png} library:: @file{libs/libpng}
* @code{zlib} library:: @file{libs/zlib}
* @code{freetype} library:: @file{libs/freetype2}
* @code{kpathsea} library:: @file{texk/kpathsea}
@end menu
@node @code{png} library
@subsection The @code{png} library in @file{libs/libpng}
@pindex png @r{library}
@pindex libpng @r{library}
This generic library uses the source tree in, e.g., the subdirectory
@file{libpng-src/} with all modifications for TL recorded in
@file{TLpatches/*}. The @file{configure.ac} fragment
@file{ac/withenable.ac} contains
@example
KPSE_WITH_LIB([libpng], [zlib])
@end example
@noindent specifying the module name, and indicating the dependency on
@code{zlib}. A third literal argument @code{tree} would specify that
the library from the @TL{} tree cannot be replaced by a system
version. That not being the case here, a second fragment
@file{ac/libpng.ac} contains
@findex KPSE_TRY_LIB
@example
KPSE_TRY_LIB([libpng],
[#include <png.h>],
[png_structp png; png_voidp io; png_rw_ptr fn;
png_set_read_fn(png, io, fn);])
@end example
@noindent thus providing the simple C code
@example
#include <png.h>
int main ()
@{ png_structp png; png_voidp io; png_rw_ptr fn;
png_set_read_fn(png, io, fn);
return 0; @}
@end example
@findex KPSE_TRY_LIBXX
@noindent which Autoconf uses to verify the usability of a system
version with C code. The analogous macro @code{KPSE_TRY_LIBXX} would
check using C++ code. These fragments are included by
@file{configure.ac} at the top level.
For this library, among many other modules, a proxy build system for
TL is used (@file{configure.ac}, @file{Makefile.am}, and
@file{include/Makefile.am}), ignoring the distributed one.
Consequently, a few generated files and auxiliary scripts are removed
from the distributed source tree. The public headers @file{png.h},
@file{pngconf.h}, and @file{pnglibconf.h} are ``installed'' (as
symlinks) under @file{include/} in the build tree exactly as they are
for a system version under, e.g., @file{/usr/include/}.
@pindex kpse-libpng-flags.m4
@vindex KPSE_LIBPNG_FLAGS
The module is supplemented by the file @file{m4/kpse-libpng-flags.m4}
that defines the M4 macro @code{KPSE_LIBPNG_FLAGS} used by all modules
depending on this library in their @file{configure.ac} to generate the
@code{make} variables @code{LIBPNG_INCLUDES} for use in
@code{CPPFLAGS}, @code{LIBPNG_LIBS} for use in @code{LDADD},
@code{LIBPNG_DEPEND} for use as dependencies, and @code{LIBPNG_RULE}
defining @code{make} rules to rebuild the library.
@file{m4/kpse-libpng-flags.m4} also supplies the configure option
@code{--with-system-libpng} and uses @code{pkg-config} to determine
the flags required for the system library.
@node @code{zlib} library
@subsection The @code{zlib} library in @file{libs/zlib}
@pindex zlib @r{library}
@pindex kpse-zlib-flags.m4
This generic library is very much analogous to @code{libpng}, but
without the dependency on any other library. The file
@file{m4/kpse-zlib-flags.m4} supplies the configure option
@code{--with-system-zlib}, as well as @code{--with-zlib-includes} and
@code{--with-zlib-libdir} to specify non-standard locations of the
@code{zlib} headers and/or library.
@node @code{freetype} library
@subsection The @code{freetype} library in @file{libs/freetype2}
@pindex freetype @r{library}
@pindex freetype-config
This module uses a wrapper build system with an almost trivial
@file{configure.ac} and with a @file{Makefile.am} that invokes
@code{configure} and @code{make} for the distributed source, followed
by @code{make install} with the build tree as destination. The flags
required for the system library are obtained through
@code{freetype-config}.
@node @code{kpathsea} library
@subsection The @code{kpathsea} library in @file{texk/kpathsea}
@pindex kpathsea @r{library}
This is one of the @TeX{}-specific libraries that are maintained as
part of @TL{} (@pxref{,,, kpathsea, Kpathsea}). Despite being a core
part of the @TeX{} system, it is not a terribly special case in the
infrastructure. The @TeX{} libraries are Libtool libraries (static
and/or shared) and are installed by @code{make install} together with
the programs. They are, however, not part of the TL DVD as
distributed by @TeX{} user groups, and have never been officially
released for standalone use.
@pindex --with-system-kpathsea
It is possible, and perhaps even useful for distro builds (@pxref{Distro
builds}), to specify the configure option @code{--with-system-kpathsea} in
order to use a system version of the library. Programs outside the TL tree
should use @code{pkg-config} for the required flags.
@pindex kpathsea.ac
@pindex mktex.ac
@vindex --enable-mktextfm-default
@pindex mktextfm
In addition to @file{ac/withenable.ac} and @file{ac/kpathsea.ac} there
is a third fragment @file{ac/mktex.ac} included by both
@file{ac/withenable.ac} and @file{configure.ac} that supplies
configure options such as @code{--enable-mktextfm-default}, which
determine the compile time default of whether or not to run
@code{mktextfm} to generate a missing @file{.tfm} file. In any case,
however, the command line options @code{-mktex=tfm} or
@code{-no-mktex=tfm} for the @TeX{}-like engines override this default.
@node Program modules
@section Program modules
@cindex program modules
@cindex modules, for programs
As with libraries (@pxref{Library modules}), here we discuss the
details for a few of the programs in TL.
@menu
* @code{t1utils} package:: @file{utils/t1utils}
* @code{xindy} package:: @file{utils/xindy}
* @code{xdvik} package:: @file{texk/xdvik}
* @code{asymptote}:: @file{utils/asymptote}
@end menu
@node @code{t1utils} package
@subsection The @code{t1utils} package in @file{utils/t1utils}
@pindex t1utils @r{package}
Once again we use the distributed source tree @file{t1utils-src}
with modifications documented in @file{TLpatches/*} and
a proxy build system consisting of @file{configure.ac} and
@file{Makefile.am}. The fragment @file{ac/withenable.ac} contains
@example
KPSE_ENABLE_PROG([t1utils])
@end example
@noindent specifying the module name without any dependencies, and
supplies the configure option @code{--disable-t1utils}.
@node @code{xindy} package
@subsection The @code{xindy} package in @file{utils/xindy}
@pindex xindy
This module uses the distributed source tree @file{xindy-src/} with
modifications documented in @file{TLpatches/*}, a proxy
@file{configure.ac}, and a wrapper @file{Makefile.am} that descends
into @file{xindy-src}. The @code{xindy} build requires a @file{make}
that supports a @code{VPATH} build, can handle all targets, and do not
refer to @code{$@{top_srcdir@}} or @code{$@{top_builddir@}}. The
fragment @code{ac/withenable.ac} contains
@example
KPSE_ENABLE_PROG([xindy], , [disable native])
m4_include(kpse_TL[utils/xindy/ac/xindy.ac])
m4_include(kpse_TL[utils/xindy/ac/clisp.ac])
@end example
@noindent where @code{disable} in the third argument indicates that
@code{xindy} is only built if explicitly enabled by the user with
@code{configure --enable-xindy} (the need for @code{clisp} is too
painful to require by default), and @code{native} disallows cross
compilation. The additional fragments @file{ac/xindy.ac} and
@file{ac/clisp.ac} specify more @code{configure} options to be seen at
the top level with @file{ac/xindy.ac} also included by
@file{configure.ac}.
@node @code{xdvik} package
@subsection The @code{xdvik} package in @file{texk/xdvik}
@pindex xdvik
This package is maintained as part of the @TL{} tree with sources in
its top level directory and the subdirectory @file{gui}. The fragment
@code{ac/withenable.ac} contains
@example
dnl extra_dirs = texk/xdvik/squeeze
KPSE_ENABLE_PROG([xdvik], [kpathsea freetype2], [x])
m4_include(kpse_TL[texk/xdvik/ac/xdvik.ac])
@end example
@pindex squeeze/configure.ac
@cindex cross compilation, with host binary
@noindent thus specifying the dependency on the @code{kpathsea},
@code{freetype}, and X11 libraries. The M4 comment (following
@code{dnl}) signals the subsidiary @file{squeeze/configure.ac}. This
is needed because the main executable @file{xdvi-bin} (to be installed
as, e.g., @file{xdvi-xaw}) is for the @code{host} system whereas the
auxiliary program @file{squeeze/squeeze} has to run on the
@code{build} system and in a cross compilation they differ.
@vindex --with-xdvi-x-toolkit
The additional fragment @code{ac/xdvik.ac} is also included by
@file{configure.ac} and supplies the configure option
@code{--with-xdvi-x-toolkit} also seen at the top-level.
@node @code{asymptote}
@subsection The subdirectory @file{utils/asymptote}
@pindex asymptote
@pindex xasy
@cindex OpenGL, required for Asymptote
This subdirectory contains the sources for @file{asy} and @file{xasy}
but due to its complexity and prerequisites (e.g., OpenGL) it is
not part of the TL build system. These programs must be built and
installed independently, but are included on the TL DVD together with
their support files.
@node Extending @TL{}
@section Extending @TL{}
@cindex extending @TL{}
@cindex adding to @TL{}
This section outlines the basic process for adding new packages to the
TL build system.
In any case, a new package directory @file{foo} should contain the
original sources, as modified for TL, in @file{foo/foo-src}, and the
changes should be documented in @file{foo/TLpatches/*}; changes should
also be submitted upstream whenever reasonable, of course. In
addition, @file{foo/} will need the usual Automake build-related files
(@file{configure.ac}, @file{Makefile.am}, etc. Please keep a
@file{ChangeLog} for all TL changes.
@menu
* Adding a new program module::
* Adding a new generic library module::
* Adding a new @TeX{}-specific library module::
@end menu
@node Adding a new program module
@subsection Adding a new program module
@cindex adding a new program
@cindex program module, adding
@vindex kpse_texk_pkgs
A @TeX{}-specific program module in a subdirectory
@file{texk/@var{prog}} may use the @TeX{}-specific libraries and is
included by adding its name @file{@var{prog}} to the M4 list
@code{kpse_texk_pkgs} defined in @file{m4/kpse-pkgs.m4}.
@vindex kpse_utils_pkgs
A generic program module in a subdirectory @file{utils/@var{prog}}
must not use the @TeX{}-specific libraries and is included by adding
its name @file{@var{prog}} to the M4 list @code{kpse_utils_pkgs} in
@file{m4/kpse-pkgs.m4}.
@pindex withenable.ac@r{, for new modules}
@findex KPSE_ENABLE_PROG
In either case, the subdirectory @file{texk/@var{prog}} or
@file{utils/@var{prog}} must provide a fragment
@file{ac/withenable.ac} that contains the M4 macro
@code{KPSE_ENABLE_PROG} defined in @file{m4/kpse-setup.m4} with
@code{@var{prog}} as the mandatory first argument and three optional
arguments:
@enumerate
@item a list of required libraries from the TL tree;
@item a list of options (@code{disable} if this module is not to be
built without the configure option @code{--enable-@var{prog}},
@code{native} if cross compilation is not possible, @code{x} if the
program requires X11 libraries);
@item a comment added to the help text for the @code{configure}
option @code{--enable-@var{prog}} or @code{--disable-@var{prog}}.
@end enumerate
If the module requires specific configure options to be seen at the
top level, they should be defined in an additional fragment
@file{ac/@var{prog}.ac} included from @file{ac/withenable.ac} and
@file{configure.ac}.
Usually, the new program is maintained somewhere outside of @TL{}. In
that case, we put the upstream sources into a subdirectory
@file{@var{prog}-src} (e.g., @file{utils/newprog/newprog-src}). We do
not run @code{configure} in this original @code{...-src} directory,
only in our own directory, but we do compile using the source files in
@code{...-src}.
So, these are the files that we must generally create:
@table @file
@item ac/withenable.ac
The @code{KPSE_ENABLE_PROG} call just explained.
@item configure.ac
@itemx Makefile.am
By merging the contents of the original @file{configure.ac} (if
provided) and a comparable program already in TL. There is no magic
recipe, it's necessary to think about needs to be done in the original
vs.@: in @TL{}.
@item TLpatches/TL-Changes
Actions taken after getting the original source tree; typically
removal of derived or unused common files.
@item TLpatches/patch-...
If any changes are needed to the original sources, record the patches
here so they can be applied next time. And send them upstream so that
perhaps they won't have to be.
@item ChangeLog
Record all TL-specific changes, now and in the future.
@end table
Then, run GNU @code{autoreconf} in the new directory (@pxref{Build
system tools}). After that works, @code{svn add} the necessary files,
notably @file{Makefile.in aclocal.m4 configure}, and @code{svn:ignore}
the Automake cache @file{autom4te.cache}. (This is so people checking
out the TL source tree do not have to run any autotools, but can
simply run @code{configure}.)
Then, run the TL tool @code{reautoconf} in the top-level TL
@code{source/} directory, to incorporate the new program into the
build tree.
Then, run (and rerun) a build until the program compiles and tests
successfully, probably involving rerunning autoreconf in the source
directory, @code{make} in the build directory, etc.
After final success, don't forget to commit.
@node Adding a new generic library module
@subsection Adding a new generic library module
@cindex adding a new generic library
@cindex generic library module, adding
@cindex library module, generic, adding
@vindex kpse_libs_pkgs
A generic library module in a subdirectory @file{libs/@var{lib}} must
not depend on @TeX{}-specific libraries, by definition. It is
included by adding its name @file{@var{lib}} to the M4 list
@code{kpse_libs_pkgs} in @file{m4/kpse-pkgs.m4}---before any other
libraries from the @TL{} tree on which it depends.
@findex KPSE_WITH_LIB
As with program modules, the subdirectory @file{libs/@var{lib}} must
contain the sources and build system for the library (and any
installable support programs) and a fragment @file{ac/withenable.ac}
that contains the M4 macro @code{KPSE_WITH_LIB} defined in
@file{m4/kpse-setup.m4} with @code{@var{lib}} as the mandatory first
argument and two optional arguments: a list of required libraries from
the TL tree, and a list of options (currently there is only one:
specify @code{tree} if this library cannot be replaced by a system
version).
@findex KPSE_TRY_LIB
@findex KPSE_TRY_LIBXX
If a system version can be used, a second fragment
@file{ac/@var{lib}.ac} is needed, containing the M4 macro
@code{KPSE_TRY_LIB} (or @code{KPSE_TRY_LIBXX}) with @code{@var{lib}}
as the mandatory first argument and two additional arguments for the
Autoconf macro @code{AC_LANG_PROGRAM} used to compile and link a small
C (or C++) program as sanity check for using the system library.
@vindex KPSE_@var{LIB}_FLAGS
In addition a file @file{m4/kpse-@var{lib}-flags} (at the top level)
must define the M4 macro @code{KPSE_@var{LIB}_FLAGS} (all uppercase)
setting up the @code{make} variables @code{@var{LIB}_INCLUDES},
@code{@var{LIB}_LIBS}, @code{@var{LIB}_DEPEND}, and
@code{@var{LIB}_RULE} with the values required for @code{CPPFLAGS},
@code{LDADD}, dependencies, and a (multi-line) @code{make} rule to
rebuild the library when necessary. All of that is needed for the
library from the TL tree and, if supported, for a system version.
@vindex --with-system-@var{lib}
@vindex KPSE_@var{LIB}_SYSTEM_FLAGS
@vindex KPSE_ALL_SYSTEM_FLAGS
If a system library is allowed, @code{KPSE_@var{LIB}_FLAGS} also
provides the configure option @code{--with-system-@var{lib}} and uses
the additional M4 macro @code{KPSE_@var{LIB}_SYSTEM_FLAGS} to generate
the @code{make} variables for a system library. Furthermore the
definition of the M4 macro @code{KPSE_ALL_SYSTEM_FLAGS} in
@file{m4/kpse-pkgs.m4} must be extended by the line:@*@ @ @
@code{AC_REQUIRE([KPSE_@var{LIB}_SYSTEM_FLAGS])}
@node Adding a new @TeX{}-specific library module
@subsection Adding a new @TeX{}-specific library module
@cindex adding a new @TeX{}-specific library
@cindex @TeX{}-specific library module, adding
@cindex library module, @TeX{}-specific, adding
A @TeX{}-specific library module in a subdirectory
@file{texk/@var{lib}} may depend on other @TeX{}-specific libraries
but must not depend on any generic library from the TL tree. It is
included in the same general ways as a generic library (see the
previous section), with these modifications:
@itemize @bullet
@item
@vindex kpse_texlibs_pkgs
The library name @code{@var{lib}} is added to the M4 list
@code{kpse_texlibs_pkgs} also in @file{m4/kpse-pkgs.m4}.
@item
@findex KPSE_WITH_TEXLIB
The fragment @code{ac/withenable.ac} must use @code{KPSE_WITH_TEXLIB}.
@end itemize
@node Configure options
@chapter Configure options
@cindex @code{configure} options
Corresponding to the large number of program and library modules there
are a large number @code{configure} options, most of which are
described here. The command@*@ @ @ @code{configure --help}@*at the
top level gives an exhaustive list of all global options and a few
important module-specific ones, whereas, e.g.,@*@ @ @
@code{texk/lcdf-typetools/configure --help}@* also displays the
@code{lcdf-typetools} specific options, which are not shown at the
top-level.
@cindex environment variables, for @code{configure}
The help text also mentions several influential environment variables,
but for @TL{} it is better to specify them as assigments on the
command line.
The @file{./Build} script used to make the binaries shipped with @TL{}
invokes the top-level @code{configure} with a few additional options
(@pxref{Building}). The defaults discussed below are those for the
actual @code{configure} script; invoking @code{configure} via
@file{./Build} may yield different results.
Defaults for most options are set at the top level and propagated
explicitly to all subdirectories. Options specified on the command
line are checked for consistency but never modified.
@menu
* Global configure options::
* Program-specific configure options::
* Library-specific configure options::
* Variables for configure::
@end menu
@node Global configure options
@section Global configure options
@cindex global @code{configure} options
@cindex @code{configure} options, global
Here are the global configure options.
@menu
* @code{--disable-native-texlive-build}::
* @code{--prefix} @code{--bindir} @dots{}::
* @code{--disable-largefile}::
* @code{--disable-missing}::
* @code{--enable-compiler-warnings=}@var{level}::
* @code{--enable-cxx-runtime-hack}::
* @code{--enable-maintainer-mode}::
* @code{--enable-multiplatform}::
* @code{--enable-shared}::
* @code{--enable-silent-rules}::
* @code{--without-ln-s}::
* @code{--without-x}::
@end menu
@node @code{--disable-native-texlive-build}
@subsection @code{--disable-native-texlive-build}
@vindex --disable-native-texlive-build
If enabled (the default), build for a TL binary distribution as
shipped by the @TeX{} user groups. This requires GNU @code{make} and
implies @code{--enable-multiplatform} and
@code{--enable-cxx-runtime-hack} (unless they are explicitly disabled),
and enforces @code{--disable-shared}.
If building TL for a GNU/Linux or other distribution, this should be
disabled and system versions of most libraries would be used
(@pxref{Distro builds}). This may fail without GNU @code{make}, but
will be tried regardless.
@vindex --enable-texlive-build
A related option, @code{--enable-texlive-build}, is automatically
passed to all subdirectories (and cannot be disabled). Subdirectories
that can also be built independently from the TL tree (such as
@file{utils/xindy} and @file{texk/dvipng}) can use this option, e.g.,
to choose TL-specific installation paths.
@node @code{--prefix} @code{--bindir} @dots{}
@subsection @code{--prefix}, @code{--bindir}, @dots{}
@vindex --prefix configure @r{option}
@vindex --bindir configure @r{option}
These standard Autoconf options specify various installation
directories as usual. For the complete list, @pxref{Installation
directories}.
@vindex DESTDIR
Also as usual, all values are prefixed by the value of @code{DESTDIR},
if set, on the @code{make} command line (@pxref{Staged Installs, ,
Installation in a temporary location, automake, GNU Automake}).
@node @code{--disable-largefile}
@subsection @code{--disable-largefile}
@vindex --disable-largefile
@cindex large file support
@cindex LFS (large file support)
Omit large file support (LFS), needed on most 32-bit Unix systems for
files with 2GB or more. Regardless of this, the size of @code{DVI}
and @code{GF} files must always be @math{<2}GB, due to the file format
specifications.
@cindex size of PDF and PS files
@cindex PDF files, size of
@cindex PostScript files, size of
With LFS, there is no fixed limit on the size of PDF files created by
@file{pdftex} or PostScript files created by @file{dvips}. The size
of PDF images included by @file{pdftex} or @file{luatex} must, however,
be @math{<2}GB when using @file{poppler} version@tie{}0.22 or before
(even on 64-bit systems with LFS).
@node @code{--disable-missing}
@subsection @code{--disable-missing}
@vindex --disable-missing
Immediately terminate the build process if a requested program or feature
must be disabled, e.g., due to missing libraries. This can help when
figuring out a specific (sub)set of modules to enable.
@node @code{--enable-compiler-warnings=}@var{level}
@subsection @code{--enable-compiler-warnings=}@var{level}
@vindex --enable-compiler-warnings=@var{level}
Enable various levels of compiler warnings for (Objective) C and C++:
the @var{level} value can be one of: @code{no min yes max all}.
The default is @code{yes} in @code{maintainer-mode} (see below) and
@code{min} otherwise. This option defines
@code{WARNING_[OBJ]C[XX]FLAGS} but these flags are not used in all
library and program modules. Using them should help to resolve
portability problems.
At present, these warning flags are only defined for the GNU compilers
but flags for other compilers could be added when needed.
@node @code{--enable-cxx-runtime-hack}
@subsection @code{--enable-cxx-runtime-hack}
If enabled (as it is for the native TL build) and when using
@code{g++}, try to statically link with @code{libstdc++}, somewhat
improving portability of the resulting binary. @xref{Macros for
compilers}.
@node @code{--enable-maintainer-mode}
@subsection @code{--enable-maintainer-mode}
@vindex --enable-maintainer-mode
Enable @file{make} rules and dependencies not useful (and sometimes
confusing) to the casual user. This requires current versions of the
GNU build tools (@pxref{Build system tools}), as it automatically
rebuilds infrastructure files as needed. @xref{maintainer-mode,,
@code{missing} and @code{AM_MAINTAINER_MODE}, automake, GNU Automake}.
@node @code{--enable-multiplatform}
@subsection @code{--enable-multiplatform}
@vindex --enable-multiplatform
@vindex exec_prefix
@vindex --bindir configure @r{option}
@vindex --libdir configure @r{option}
If enabled and @code{--bindir=@var{dir}} or @code{--libdir=@var{dir}}
are not specified, install executables and libraries in per-platform
subdirectories of @file{@var{eprefix}/bin} and
@file{@var{eprefix}/lib} where @var{eprefix} is the value given or
implied for @code{exec_prefix}. In any case, the values for
@code{bindir} and @code{libdir} are automatically propagated to all
subdirectories.
@node @code{--enable-shared}
@subsection @code{--enable-shared}
@vindex --enable-shared
Build shared versions of the @TeX{}-specific libraries such as
@file{libkpathsea}. This is not allowed for a native TL build (i.e.,
@code{--disable-native-texlive-build} must also be specified).
@node @code{--enable-silent-rules}
@subsection @code{--enable-silent-rules}
@vindex --enable-silent-rules
Enable the use of less verbose build rules. When using GNU
@code{make} (or another @code{make} implementation supporting nested
variable expansions), you can specify @code{V=1} on the @code{make} command
line to get more verbosity, or @code{V=0} to get less, regardless of
this option.
@node @code{--without-ln-s}
@subsection @code{--without-ln-s}
@vindex --without-ln-s
Required when using a system without a working @code{ln -s} to build
binaries for a Unix-like system. However, @code{make install} will
not create anything useful and might even fail.
@node @code{--without-x}
@subsection @code{--without-x}
@vindex --without-x
Disable all programs using the X Window System.
@node Program-specific configure options
@section Program-specific configure options
@cindex program-specific @code{configure} options
@cindex @code{configure} options, program-specific
Here are (some of) the program-specific @code{configure} options.
@menu
* @code{--enable-@var{prog}} @code{--disable-@var{prog}}::
* @code{--disable-all-pkgs}::
* Configure options for @file{texk/web2c}::
* Configure options for @file{texk/bibtex-x}::
* Configure options for @file{texk/dvipdfm-x}::
* Configure options for @file{texk/dvisvgm}::
* Configure options for @file{texk/texlive}::
* Configure options for @file{texk/xdvik}::
* Configure options for @file{utils/xindy}::
@end menu
@node @code{--enable-@var{prog}} @code{--disable-@var{prog}}
@subsection @code{--enable-@var{prog}}, @code{--disable-@var{prog}}
@vindex --enable-@var{prog}
@vindex --disable-@var{prog}
Do or do not build and install the program(s) of the module @code{@var{prog}}.
@node @code{--disable-all-pkgs}
@subsection @code{--disable-all-pkgs}
@vindex --disable-all-pkgs
Do not build any program modules by default---only those explicitly
enabled. This is useful when one wants to work on only a single
program, which is specified with an additional @code{--enable} option,
e.g., @code{--enable-dvipdfm-x}. It's still simplest to check out and
configure the whole source tree, but at least only the program you are
interested in, and its dependencies, are built. The @code{configure}
will generally take less than a minute with everything disabled. (It
is a good idea to run @code{make check} after doing this, and after
making any changes, to ensure that whatever tests have been written
still pass.)
Without this option, all modules are built except those that are
explicitly disabled or specify @code{disable} in their
@file{ac/withenable.ac} fragment.
@node Configure options for @file{texk/web2c}
@subsection Configure options for @file{texk/web2c}
@cindex @code{configure} options, for @code{web2c}
@vindex --with-banner-add=@var{str}
@noindent @code{--with-banner-add=@var{str}}@*Add @code{@var{str}} to the
default version string (@code{TeX Live @var{year}} or @code{Web2C
@var{year}}) appended to banner lines. This is ignored for a native
TL build, but distro builds should specify, e.g.,
@code{/@var{SomeDistro}}.
@vindex --with-editor=@var{cmd}
@noindent @code{--with-editor=@var{cmd}}@*Specify the command
@code{@var{cmd}} to invoke from the @code{e} option of @TeX{}-like engines,
replacing the default @code{vi +%d '%s'} for Unix or @code{texworks
--position=%d "%s"} for Windows.
@vindex --with-fontconfig-includes=@var{dir}
@vindex --with-fontconfig-libdir=@var{dir}
@noindent @code{--with-fontconfig-includes=@var{dir}},
@code{--with-fontconfig-libdir=@var{dir}}@*Building Xe@TeX{} on
non-Mac systems requires the @code{fontconfig} library headers and
code. If one or both of these options are given, the required flags
are derived from them; otherwise, they are determined via
@file{pkg-config} (if present).
@cindex X toolkit
@pindex libXt
@pindex Xlib
@noindent @code{--with-mf-x-toolkit}@*Use the X toolkit (@file{libXt}) for
Metafont (the default is to use the lowest-level @file{Xlib} support;
it seems this has the best chance of working across X installations
nowadays).
@vindex --disable-dump-share
@cindex LittleEndian architectures
@noindent @code{--disable-dump-share}@*Make the @code{fmt}/@code{base}
dump files architecture dependent (somewhat faster on LittleEndian
architectures).
@vindex --disable-ipc
@cindex interprocess communication
@noindent @code{--disable-ipc}@*Disable @TeX{}'s @code{--ipc} option.
@vindex --disable-mf-nowin
@pindex mf-nowin
@noindent @code{--disable-mf-nowin}@*Do not build a separate
non-graphically-capable Metafont (@file{mf-nowin}).
@vindex --disable-tex
@vindex --enable-etex
@pindex web2c.ac
@noindent @code{--disable-tex}, @code{--enable-etex}, @dots{}@*Do not or
do build the various @TeX{}, Metafont, and MetaPost engines (defaults are
defined in the fragment @file{texk/web2c/ac/web2c.ac}).
@vindex --disable-web-progs
@noindent @code{--disable-web-progs}@*Do not build the core WEB programs
@file{bibtex}, @dots{}, @file{weave}. Useful if, e.g., you only want
to (re)build some engines.
@vindex --enable-auto-core
@cindex preloaded binaries
@noindent @code{--enable-auto-core}@*This option causes @TeX{} and Metafont
to produce a core dump when a particular hacky filename is
encountered, for use in creating preloaded binaries. This is rarely
done nowadays.
@vindex --enable-libtool-hack
@pindex libtool@r{, hack for avoiding excessive linking}
@noindent @code{--enable-libtool-hack}@*
If enabled (which is the default for all platforms), prevents
@code{libtool} from linking explicitly with dependencies of
@file{libfontconfig} such as @file{libexpat}.
@vindex --enable-*win @r{for Metafont window support}
@noindent @code{--enable-*win}@*Include various types of other window
support for Metafont (EPSF output, @code{mftalk}, old terminals, @dots{}).
@vindex --enable-tex-synctex
@vindex --disable-etex-synctex
@cindex synctex
@noindent @code{--enable-tex-synctex}, @code{--disable-etex-synctex},
@dots{}@*Build the @TeX{} engines with or without @code{SyncTeX}
support; ignored for a native @TL{} build, defaults are again defined
in @file{texk/web2c/ac/web2c.ac}.
@vindex --disable-synctex
@cindex synctex
@noindent @code{--disable-synctex}
@*Do not build the @code{SyncTeX} library and tool.
@node Configure options for @file{texk/bibtex-x}
@subsection Configure options for @file{texk/bibtex-x}
@cindex @code{configure} options, for @code{bibtex-x}
@pindex bibtex8
@pindex bibtexu
@pindex bibtex-x
The programs @code{bibtex8} and @code{bibtexu} have been merged into the
module @code{bibtex-x} (extended Bib@TeX{}).
@vindex --disable-bibtex8
@noindent @code{--disable-bibtex8}@*Do not build the @file{bibtex8} program.
@vindex --disable-bibtexu
@noindent @code{--disable-bibtexu}@*Do not build the @file{bibtexu} program
(building @file{bibtexu} requires @code{ICU} libraries).
@node Configure options for @file{texk/dvipdfm-x}
@subsection Configure options for @file{texk/dvipdfm-x}
@cindex @code{configure} options, for @code{dvipdfm-x}
@pindex dvipdfmx
@pindex xdvipdfmx
The former modules @code{dvipdfmx} (extended DVI to PDF converter) and
@code{xdvipdfmx} (the same, as used by Xe@TeX{}) have been merged into
@code{dvipdfm-x} at the source level. Two separate binaries are still
created by default. In addition, @file{dvipdfm} is created as a
symlink to @file{dvipdfmx}, with backward-compatible (very slightly
different) behavior.
@vindex --disable-dvipdfmx
@noindent @code{--disable-dvipdfmx}@*Do not build the @file{dvipdfmx}
program with the @file{dvipdfm} symlink.
@vindex --disable-xdvipdfmx
@noindent @code{--disable-xdvipdfmx}@*Do not build the @file{xdvipdfmx}
program.
@node Configure options for @file{texk/dvisvgm}
@subsection Configure options for @file{texk/dvisvgm}
@cindex @code{configure} options, for @file{dvisvgm}
@pindex dvisvgm
@vindex --with-system-libgs
@noindent @code{--with-system-libgs}@*Build @file{dvisvgm} using installed
Ghostscript (@code{gs}) headers and library (not allowed for a native
TL build). The default is to load the @code{gs} library at runtime if
possible, or otherwise disable support for PostScript specials.
@vindex --without-libgs
@noindent @code{--without-libgs}@*Build @file{dvisvgm} without PostScript
support at all. Because the dynamic loading just mentioned defeats all
attempts at static linking, the result can crash due to library
incompatibilities, e.g., on CentOS 5.
@vindex --with-libgs-includes@r{,} -libdir
@noindent @code{--with-libgs-includes=@var{dir}},
@code{--with-libgs-libdir=@var{dir}}@*Specify non-standard locations
of the Ghostscript headers and library.
@node Configure options for @file{texk/texlive}
@subsection Configure options for @file{texk/texlive}
@cindex @code{configure} options, for @file{texk/texlive}
@vindex --disable-linked-scripts
@noindent @code{--disable-linked-scripts}@*Do not install the ``linked
scripts'' (@pxref{Linked scripts}), except for the TL scripts required
to run @code{texlinks}.
@node Configure options for @file{texk/xdvik}
@subsection Configure options for @file{texk/xdvik}
@cindex @code{configure} options, for @file{xdvik}
@pindex xdvik
@vindex --with-gs=@var{filename}
@noindent @code{--with-gs=@var{filename}}@*Hardwire the location of Ghostscript
(@file{gs}).
@vindex --with-xdvi-x-toolkit=@var{kit}
@pindex motif
@pindex xaw
@noindent @code{--with-xdvi-x-toolkit=@var{kit}}@*Use toolkit
@code{@var{kit}} for @file{xdvik}, one of: @code{motif xaw xaw3d
neXtaw}. The default is @code{motif} if available, else @code{xaw}.
@vindex --enable-xi2-scrolling
@pindex XInput
@pindex scrolling
@noindent @code{--enable-xi2-scrolling}@*Use XInput 2.1 ``smooth scrolling''
if available. (default: yes, except for a native TL build).
@node Configure options for @file{utils/xindy}
@subsection Configure options for @file{utils/xindy}
@cindex @code{configure} options, for @file{xindy}
@pindex xindy
@vindex --enable-xindy-rules
@noindent @code{--enable-xindy-rules}@*Build and install @code{xindy} rules
(default: yes, except for a native TL build).
@vindex --enable-xindy-docs
@noindent @code{--enable-xindy-docs}@*Build and install @code{xindy}
documentation (default: yes, except for a native TL build).
@vindex --with-clisp-runtime=@var{filename}
@pindex lisp.run@r{,} lisp.exe
@cindex CLISP
@noindent @code{--with-clisp-runtime=@var{filename}}@*Specifies the
Full path for the CLISP runtime file (@file{lisp.run} or
@file{lisp.exe}) to be installed. When specified as @code{default}
(the default for a native TL build) the path is determined by the
CLISP executable; the value @code{system} (not allowed for a native TL
build, but the default for a non-native one) indicates that
@file{xindy} will use the installed version of @file{clisp} (which
must be identical to the one used to build @file{xindy}).
@node Library-specific configure options
@section Library-specific configure options
@cindex library-specific @code{configure} options
@cindex @code{configure} options, library-specific
Here are (some of) the library-specific @code{configure} options,
starting with this generic one:
@vindex --with-system-@var{lib}
@noindent @code{--with-system-@var{lib}}
Use an installed (system) version of the library @code{@var{lib}};
this option exists for most libraries, but is not allowed for a native
TL build. Using a system version implies also using the system
versions of all libraries (if any) that @var{lib} depends on.
@vindex --with-@var{lib}-includes=@var{dir}@r{,} -libdir
For many libraries @code{--with-@var{lib}-includes=@var{dir}} and
@code{--with-@var{lib}-libdir=@var{dir}} can specify non-standard
search locations; others use @file{pkg-config} or similar to determine
the required flags.
The top-level @file{configure} script performs a consistency check for all
required system libraries and bails out if tests fail.
@menu
* Configure options for @code{kpathsea}::
* Configure options for system @code{poppler}::
@end menu
@node Configure options for @code{kpathsea}
@subsection Configure options for @code{kpathsea}
@cindex @code{configure} options, for @code{kpathsea}
@noindent @code{--enable-@var{cmd}-default},
@code{--disable-@var{cmd}-default}@*Determine the compile time default
whether or not to run @var{cmd}, one of:
@table @code
@item mkocp
(Omega compiled translation process file)
@item mkofm
(Omega font metrics file)
@item mktexfmt
(format/base dump file)
@item mktexmf
(Metafont source)
@item mktexpk
(PK bitmap font)
@item mktextex
(@TeX{} source)
@item mktextfm
(TFM file)
@end table
@noindent to generate the specified type of file dynamically.
The default can be overridden by the user in any case.
@node Configure options for system @code{poppler}
@subsection Configure options for system @code{poppler}
@cindex @code{configure} options, for system @code{poppler}
@pindex poppler
@pindex xpdf @r{as library}
Building Lua@TeX{} (or LuaJIT@TeX{}) and Xe@TeX{} requires
@code{poppler}, either from the TL tree or system headers and
library. Building pdf@TeX{} requires either @code{xpdf} from
the @TL{} tree or system @code{poppler} headers and library.
@vindex --with-system-poppler
@noindent @code{--with-system-poppler}@*Use a system version (0.18 or
newer) of @code{poppler} for Lua@TeX{} (or LuaJIT@TeX{}) and Xe@TeX{},
and use @file{pkg-config} to obtain the required flags.
@vindex --with-system-xpdf
@noindent @code{--with-system-xpdf}@*Use a system version (0.12 or better)
of @code{poppler} (and @file{pkg-config}) for pdf@TeX{} instead of
@code{xpdf} from the TL tree. @xref{@code{--disable-largefile}}.
@node Variables for configure
@section Variables for configure
@cindex variables for @code{configure}
@cindex @code{configure} variables
The values for these variables can be specified as @code{configure}
arguments of the form @code{@var{VAR}=@var{value}}. They can also be
defined in the environment, but that might not work for cross
compilations.
@vtable @code
@item CC
@itemx CXX
@itemx CPPFLAGS
And plenty more. As usual with Autoconf, these variables specify the
name (or full path) of compilers, preprocessor flags, and similar.
@xref{Preset Output Variables,, autoconf, GNU Autoconf}.
@item CLISP
@pindex clisp
Name (or full path) of the @file{clisp} executable, used to build
@code{xindy}.
@item FT2_CONFIG
@itemx ICU_CONFIG
@itemx PKG_CONFIG
@pindex freetype-config
@pindex icu-config
@pindex libfreetype
@cindex ICU libraries
These specify the name (or path) for the @file{freetype-config},
@file{icu-config}, and @file{pkg-config} commands used to determine the
flags required for system versions of @file{libfreetype}, the ICU
libraries, or many other libraries.
@item KPSEWHICH
@pindex kpsewhich
Name (or path) of an installed @file{kpsewhich} binary, used by
@code{make check} to determine the location of, e.g.,
@file{cmbx10.tfm}.
@item MAKE
@itemx SED
And more. Name (or path) of the @code{make}, @code{sed}, and similar
programs; used at the top level and propagated to all subdirectories.
@item PERL
@itemx LATEX
@itemx PDFLATEX
Name (or full path) for the @file{perl}, @file{latex}, and @file{pdflatex}
commands used, e.g., to build the @code{xindy} documentation.
@end vtable
@node Cross compilation
@chapter Cross compilation
@cindex cross compilation
In a cross compilation a @dfn{build} system is used to create
binaries to be executed on a @dfn{host} system with different
hardware and/or operating system.
@cindex native cross compilation
In simple cases, the build system can execute binaries for the host
system. This typically occurs for bi-arch systems where, e.g.,
@code{i386-linux} binaries can run on @code{x86_64-linux} systems and
@code{win32} binaries can run on @code{win64} systems. Although
sometimes called ``native cross'', technically this is not cross
compilation at all. In most such cases it suffices to specify
suitable compiler flags. It might be useful to add the configure
option @code{--build=@var{host}} to get the correct canonical host
name, but note that this should @emph{not} be @code{--host=@var{host}}
(@pxref{Hosts and Cross-Compilation,,, autoconf, GNU Autoconf}).
In order to build, e.g., 32-bit binaries with @command{clang} on a 64-bit
MacOSX system one could use:
@example
TL_BUILD_ENV="CC='clang -arch i386' \
CXX='clang++ -arch i386' \
OBJCXX='clang++ -arch i386'" \
./Build --build=i386-apple-darwin
@end example
@menu
* Cross configuring:: Configuring for cross compilation.
* Cross problems:: Cross compilation problems.
@end menu
@node Cross configuring
@section Cross configuring
@cindex cross compilation configuring
@cindex configuring, for cross compilation
@vindex --host=@var{host}
@vindex --build=@var{host}
In a standard cross compilation, binaries for the host system cannot
execute on the build system and it is necessary to specify the
configure options @code{--host=@var{host}} and
@code{--build=@var{build}} with two different values.
Building binaries requires suitable ``cross'' tools, e.g., compiler,
linker, and archiver, and perhaps a ``cross'' version of
@code{pkg-config} and similar to locate host system libraries.
Autoconf expects that these cross tools are given by their usual
variables or found under their usual name prefixed with
@code{@var{host}-}. Here a list of such tools and corresponding
variables:
@example
@code{ar} AR
@code{freetype-config} FT2_CONFIG
@code{g++} CXX
@code{gcc} CC
@code{icu-config} ICU_CONFIG
@code{objdump} OBJDUMP
@code{pkg-config} PKG_CONFIG
@code{ranlib} RANLIB
@code{strip} STRIP
@end example
@cindex @code{mingw32}
@noindent In order to, e.g., build @code{mingw32} binaries on
@code{x86_64-linux} with a cross compiler found as
@file{i386-pc-mingw32-gcc} one would specify
@example
--host=i386-pc-mingw32 --build=x86_64-linux-gnu
@end example
@noindent or perhaps
@example
--host=mingw32 --build=x86_64-linux CC=i386-pc-mingw32-gcc
@end example
@noindent but this latter, especially, might require adding @code{CXX} and others.
Configure arguments such as @code{CFLAGS=@dots{}} refer to the cross
compiler. If necessary, you can specify compilers and flags for the
few auxiliary C and C++ programs required for the build process as
configure arguments
@vindex BUILDCC@r{,} BUILDCFLAGS@r{, @dots{}}
@example
BUILDCC=@dots{}
BUILDCPPFLAGS=@dots{}
BUILDCFLAGS=@dots{}
BUILDCXX=@dots{}
BUILDCXXFLAGS=@dots{}
BUILDLDFLAGS=@dots{}
@end example
@node Cross problems
@section Cross problems
@cindex cross compilation problems
The fact that binaries for the host system cannot be executed on the
build system causes some problems.
One problem is that configure tests using @code{AC_RUN_IFELSE} can
compile and link the test program but cannot execute it. Such tests
should be avoided if possible and otherwise must supply a pessimistic
test result.
@pindex squeeze
@pindex web2c @r{program}
@cindex @code{freetype} cross compiling
@vindex CC_BUILD
Another problem arises if the build process must execute some
(auxiliary or installable) programs. Auxiliary programs can be placed
into a subdirectory that is configured natively as is done for
@file{texk/web2c/web2c}, @file{texk/dvipsk/squeeze}, and
@file{texk/xdvik/squeeze}. The module @file{libs/freetype2} uses the
value of @code{CC_BUILD}, @file{@var{build}-gcc}, @file{gcc}, or
@file{cc} as the compiler for the auxiliary program.
@cindex ICU cross compiling
The situation for installable programs needed by the build process is
somewhat different. A rather expensive possibility, chosen for the ICU
libraries in module @file{libs/icu}, is to first compile natively for
the build system and in a second step to use these (uninstalled)
programs during the cross compilation.
@pindex tangle
@pindex ctangle
@pindex otangle
@pindex tie
This approach would also be possible for the tools such as
@file{tangle} used in the module @file{texk/web2c} to build the WEB
programs, but that would require first building a native
@code{kpathsea} library. To avoid this complication, cross
compilation of the WEB or CWEB programs requires sufficiently recent
installed versions of @file{tangle}, @file{ctangle}, @file{otangle},
and @file{tie}.
@cindex @code{xindy} cross compiling impossible
Building @code{xindy} requires running the host system @file{clisp}
binary, thus cross compilation is not possible.
@node Coding conventions
@chapter Coding conventions
@cindex coding conventions
@cindex conventions, coding
Ideally, building all of @TL{} with @code{--enable-compiler-warnings=max}
should produce no (GCC) compiler warnings at all. In spite of
considerable efforts into that direction we are still far from that goal and
there are reasons that we may never fully reach it. Below are some rules
about declarations of functions or variables and the use of @code{const}.
These rules should be applied to most of the @TL{} tree, the exception
being code that is maintained independently and whose maintainers
don't want to accept patches.
@menu
* Declarations and definitions::
* Const::
@end menu
@node Declarations and definitions
@section Declarations and definitions
@cindex declarations and definitions, in source code
@cindex source code declarations
@cindex ANSI C
@cindex C, ANSI, required
@cindex C99, avoided
@subsubheading C standards
The @TL{} build system no longer supports pre-ANSI C compilers. Thus
all function prototypes and definitions must conform to the ANSI C
standard (including @code{void} in the declaration of C functions with
no parameters). On the other hand, TL is built for a wide variety of
systems, not all of which support the C99 standard. Therefore using
C99 features should be avoided if that can easily be done. In
particular C code must not contain declarations after statements or
C++-style comments.
@pindex chktex
@findex stpcpy
If some C99 (or later) constructs must be used, the module should
verify that they are available and otherwise provide an alternative.
For example, the module @file{texk/chktex} uses the C99 function
@code{stpcpy()} that may or may not be available on a particular
system. It uses @code{AC_CHECK_DECLS([stpcpy])} in
@file{configure.ac} to test this, and provides the perhaps slightly
less efficient alternative
@example
#if !(defined HAVE_DECL_STPCPY && HAVE_DECL_STPCPY)
static inline char *stpcpy(char *dest, const char *src)
@{
return strcpy(dest, src) + strlen(src);
@}
#endif
@end example
@noindent in the file @file{Utility.h}.
@subsubheading Static functions
@cindex @code{static} functions
Functions used in only one file should be declared @code{static}; they
require no prototype except as forward declaration.
@subsubheading Extern functions
@cindex @code{extern} functions
Functions not declared @code{static}, usually because they are used in
several files, require an (@code{extern}) prototype in exactly one
header file, which is included in the file defining the function and
in all files using that function---this is the only way to guarantee
consistency between definition and use. There should be no
@code{extern} declarations sprinkled throughout the C code (with or
without comments as to where that function is defined).
@subsubheading Variable declarations
@cindex variable declarations, in source code
The declaration of global variables follows analogous rules: they are
either declared @code{static} if used in only one file or declared
@code{extern} in exactly one header and instantiated in exactly one
file.
@node Const
@section Const
@cindex @code{const}
The @code{const} feature of C is valuable, but easy to mis-use.
@subsubheading Function parameters
Ideally, a function parameter not modified by the function should be
declared as @code{const}. This is important in particular for strings
(@code{char*}) because the actual arguments are often string literals.
It is perfectly legitimate and safe to use a type @code{char*} value
for a type @code{const char*} variable (in an assignment, as
initializer, as function argument, or as return value). It is equally
safe to use a type @code{char**} value for a type @code{const
char*const*} variable, but not for a type @code{const char**} variable
since that might cause modification of a quantity supposed to be
constant.
@cindex X11 headers, and @code{const}
@cindex @code{libfreetype}, and @code{const}
Getting all @code{const} qualifiers right can get quite involved but
can almost always be done. There are only a couple notable
exceptions: the X11 headers are full of declarations that ought to use
@code{const} but do not, and the same is true to some extent for
@file{libfreetype} (but, thankfully, not for @code{zlib} nowadays).
@subsubheading What must be avoided with @code{const}
@cindex warning, discards qualifiers
@cindex discards qualifiers warning
The GCC compiler warnings ``assignment discards qualifiers@dots{}''
and analogous warnings for ``initialization'', ``passing arg'', or
``return'' must be strenously avoided in our own code. The only
exception is when they are caused by X11 headers or macros or other
third party code.
@subsubheading What should be avoided with @code{const}
@cindex type cast, avoiding
A type cast, e.g., from @code{const char*} to @code{char*} does not
solve any problems; depending on warning options, it may only hide
them. Therefore such casts should be avoided whenever possible and
otherwise must be carefully analyzed to make sure that they cannot
cause the modification of quantities supposed to be constant.
@node Continuous integration
@chapter Continuous integration
@cindex ci
@cindex continuous integration
@cindex Travis-CI
Overview: the sources of @TL{} are subjected to continuous integration
testing on Travis-CI
(@url{https://travis-ci.org/TeX-Live/texlive-source}) via a git-svn
mirror of the sources that is pushed to Github
(@url{https://github.com/TeX-Live/texlive-source}). The git-svn mirror
is updated (currently) at 30 minute intervals, and only the last
commit pushed is tested on Travis-CI.
@subheading Transfer from Subversion to Github
git-svn (@url{https://git-scm.com/docs/git-svn}) is used to check out
the subtree @code{Build/source} of the Subversion repository. The
author index file used is not maintained in either Git or Subversion
but can be provided on request.
@c TODO what should we do here with the author index file? It contains a
@c mapping from subversion names to name/email as shown in git.
The initial checkout was done by invoking
@example
git svn --authors-file usermap clone svn://USER@@tug.org/texlive/trunk/Build/source
@end example
@noindent where the @code{usermap} file maps Subversion user names to
name and emails of the authors. If no user account at @url{tug.org} is
available, anonymous checkout is possible, too:
@example
git svn --authors-file usermap clone svn://tug.org/texlive/trunk/Build/source
@end example
In the following, we will use @emph{admin} to refer to a user who has
read/write access to the @TL{} subversion repository, and is also an
administrator of the @code{TeX-Live} Team on Github. The above initial
checkout has been carried out by @emph{admin} on the server
@code{texlive.info}.
On Github (@url{https://github.com}), a new git repository named
@code{texlive-source} was created by @emph{admin} within the
@code{TeX-Live} ``organization'' (@url{https://github.com/TeX-Live}).
The remote was added to the checkout with @code{git remote add origin
git@@github.com:TeX-Live/texlive-source.git}.
To automate the update on Github, a new ssh key was generated and added
to the @code{texlive-source} repository on Github as deployment
key. This way pushes using this key can only go to the
@code{texlive-source} repository and not anywhere else.
The usage of @code{git-svn} requires a strict discipline to keep a
linear history in the master branch. Since we are aiming at a pure
mirror facility, we have decided to further restrict the @code{master}
branch of the @code{texlive-source} repository on Github to changes by
@emph{admin}.
This setup allows other developers to branch off @code{master} and
push their branches to the Github repository, but all updates need to
come from the local @code{master} (not the one on Github) to
Subversion, back to @code{master} on @code{texlive.info}, and from
there to Github.
@subheading Automatic update of the Git mirror
@emph{admin} has installed a cron job on @code{texlive.info} running
every 30 minute which essentially runs @code{git svn rebase} and
@code{git push} in the @code{master} branch of the checkout. The first
command fetches the changes from the Subversion repository and updates
the @code{master} branch with them, the second one pushes changes (if
available) to Github.
@subheading CI testing on Travis-CI
@pindex .travis.yml
The @code{source} tree of @TL{} contains a top-level file
@code{.travis.yml} which controls the automatic testing on
Travis-CI. @emph{admin} has registered to Travis-CI and allowed access
to the Github's @code{TeX-Live} organization's @code{texlive-source}
repository. The default settings are to build the last commit of each
push. No further action is necessary on Travis-CI.
If changes have been pushed via the cron job above, Travis-CI will
automatically checkout the last pushed commit and try building it.
@comment
@comment The following needs improvement
@comment
@comment @subheading Developer setup for Git/Subversion
@comment
@comment In case a developer of code in the @TL{} source code wants to use the CI
@comment testing facility, the following steps are necessary for initialization:
@comment
@comment @itemize @bullet
@comment @item
@comment Initial @code{git-svn} checkout as laid out above, replacing
@comment @code{USER} with the Subversion user name. This initial checkout might
@comment take quite some time as the whole history has to be parsed. In case the
@comment checkout is interrupted, change into the already created folder and call
@comment @code{git svn fetch} to continue pulling from the remote until all
@comment changes have been fetched.
@comment
@comment @item
@comment Adding the Git remote as laid out above. After that it is also necessary
@comment to set the upstream for the @code{master} branch with
@comment @code{git branch --set-upstream-to=origin/master master} followed by a
@comment @code{git pull}. The last command will probably not fetch anything since
@comment but update the local information about availability.
@comment
@comment @end itemize
@comment
@comment After this development can be done as follows:
@comment
@comment @itemize @bullet
@comment @item
@comment Create a new branch based on @code{master}: @code{git checkout -b feature}
@comment and develop the new features in this branch.
@comment
@comment @item
@comment Pushing the branch to Github will kick of automatic CI testing on this
@comment branch, too.
@comment
@comment @item
@comment When the feature is ready, first the branch @code{feature} needs to be
@comment rebased onto current @code{master} with @code{git rebase master}, then
@comment merged into @code{master}, followed by a submission to the Subversion
@comment repository via @code{git svn dcommit}. Don't push to master on Github
@comment (it is anyway protected), your changes will come in in due time via a
@comment pull on master.
@comment
@comment @item
@comment After the branch is included in master, optionally delete the local and
@comment rmeote branch @code{feature}.
@comment
@comment @end itemize
@comment
@comment The above method is the standards and safest method, but there is an
@comment alternative way by first pulling from Github, and then tricking git-svn
@comment into believing that everything has been fetched from Subversion
@comment already. This alternative method is explained XXXXXXXXX (my BLOG?)
@comment
@comment
@c made from pod doc.
@include tlbuild-incl/install-tl.texi
@include tlbuild-incl/tlmgr.texi
@node Index
@unnumbered Index
@printindex cp
@bye
|