aboutsummaryrefslogtreecommitdiff log msg author committer range
path: root/doc/manual.cli
blob: 3581880419f4aea125aa7809fdef2053ce34f778 (plain)
 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  // file : doc/manual.cli // copyright : Copyright (c) 2014-2019 Code Synthesis Ltd // license : MIT; see accompanying LICENSE file "\name=build2-package-manager-manual" "\subject=package manager" "\title=Package Manager" // NOTES // // - Maximum
line is 70 characters. //  " \h0#preface|Preface|  This document describes \c{bpkg}, the \c{build2} package dependency manager. For the package manager command line interface refer to the \l{bpkg(1)} man pages.  \h1#package-name|Package Name|  The \c{bpkg} package name can contain ASCII alphabetic characters (\c{[a-zA-Z]}), digits (\c{[0-9]}), underscores (\c{_}), plus/minus (\c{+-}), and dots/periods (\c{\c{.}}). The name must be at least two characters long with the following additional restrictions:  \ol|  \li|It must start with an alphabetic character.|  \li|It must end with an alphabetic, digit, or plus character.|  \li|It must not be any of the following illegal names:  \ build con prn aux nul com1 com2 com3 com4 com5 com6 com7 com8 com9 lpt1 lpt2 lpt3 lpt4 lpt5 lpt6 lpt7 lpt8 lpt9 \  ||  The use of the plus (\c{+}) character in package names is discouraged. \N{Pluses are used in URL encoding which makes specifying packages that contain pluses in URLs cumbersome.}  The use of the dot (\c{.}) character in package names is discouraged except for distinguishing the implementations of the same functionality for different languages. \N{For example, \c{libfoo} and \c{libfoo.bash}.}  Package name comparison is case-insensitive but the original case must be preserved for display, in file names, etc. \N{The reason for case-insensitive comparison is Windows file names.}  If the package is a library then it is strongly recommended that you start its package name with the \c{lib} prefix, for example, \c{libfoo}. Some package repositories may make this a requirement as part of their submission policy.  If a package (normally a library) supports usage of multiple major versions in the same project, then it is recommended to append the major version number to the package name starting from version \c{2.0.0}, for example, \c{libfoo} (before \c{2.0.0}), \c{libfoo2}, \c{libfoo3} (\c{3.Y.Z}), etc.   \h1#package-version|Package Version|  The \c{bpkg} package version format tries to balance the need of accommodating existing software versions on one hand and providing a reasonably straightforward comparison semantics on another. For some background on this problem see \cb{deb-version(1)} and the \l{http://semver.org Semantic Versioning} specification.  Note also that if you are strating a new project that will use the \c{build2} toolchain, then it is strongly recommended that you use the \i{standard versioning} scheme which is a more strictly defined subset of semanic versioning and that allows automation of many version management tasks. See \l{b#module-version \c{version} Module} for details.  The \c{bpkg} package version has the following form:  \ [+-][-][+][#] \  The \i{epoch} part should be an integer. It can be used to change to a new versioning scheme that would be incompatible with the old one. If not specified, then \i{epoch} defaults to \c{1} except for a stub version (see below) in which case it defaults to \c{0}. The explicit zero \i{epoch} can be used if the current versioning scheme (for example, date-based) is known to be temporary.  The \i{upstream} part is the upstream software version that this package is based on. It can only contain alpha-numeric characters and \c{.}. The \c{.} character is used to separate the version into \i{components}.  The \i{prerel} part is the upstream software pre-release marker, for example, alpha, beta, candidate, etc. Its format is the same as for \i{upstream} except for two special values: the absent \i{prerel} (for example, \c{1.2.3}) signifies the maximum or final release while the empty \i{prerel} (for example, \c{1.2.3-}) signifies the minimum or earliest possible release. \N{The minimum release is intended to be used for version constraints (for example, \c{libfoo < 1.2.3-}) rather than actual releases.}  The \i{revision} part should be an integer. It is used to version package releases that are based on the same upstream versions. If not specified, then \i{revision} defaults to \c{0}.  The \i{iteration} part is an integer. It is used internally by \c{bpkg} to automatically version modifications to the packaging information (specifically, to package manifest and lockfile) in \i{external packages} that have the same upstream version and revision. As a result, the \i{iteration} cannot not be specified by the user and is only shown in the \c{bpkg} output (for example, by \c{pkg-status} command) in order to distinguish between package iterations with otherwise identical versions. Note also that \i{iteration} is relative to the \c{bpkg} configuration. Or, in other words, it is an iteration number of a package as observed by a specific configuration. As a result, two configuration can \"see\" the same package state as two different iterations.  \N|Package iterations are used to support package development during which requiring the developer to manually increment the version or revision after each modification would be impractical. This mechanism is similar to the automatic commit versioning provided by the \i{standard version} except that it is limited to the packaging information but works for uncommitted changes.|  Version \c{+0-0-} (least possible version) is reserved and specifying it explicitly is illegal. \N{Explicitly specifying this version does not make much sense since \c{libfoo < +0-0-} is always false and \c{libfoo > +0-0-} is always true. In the implementation this value is used as a special empty version.}  Version \c{0} (with a potential revision, for example, \c{0+1}, \c{0+2}) is used to signify a \i{stub package}. A stub is a package that does not contain source code and can only be \"obtained\" from other sources, for example, a system package manager. Note that at some point a stub may be converted into a full-fledged package at which point it will be assigned a \"real\" version. It is assumed that this version will always be greater than the stub version.  When displaying the package version or when using the version to derive the file name, the default \i{epoch} value as well as zero \i{revision} and \i{iteration} values are omitted (even if they were explicitly specified, for instance, in the package manifest). For example, \c{+1-1.2.3+0} will be used as \c{libfoo-1.2.3}.  \N|This versioning scheme and the choice of delimiter characters (\c{.-+}) is meant to align with semantic versioning.|  Some examples of versions:  \ 0+1 +0-20180112 1.2.3 1.2.3-a1 1.2.3-b2 1.2.3-rc1 1.2.3-alpha1 1.2.3-alpha.1 1.2.3-beta.1 1.2.3+1 +2-1.2.3 +2-1.2.3-alpha.1+3 +2.2.3#1 1.2.3+1#1 +2-1.2.3+1#2 \  The version sorting order is \i{epoch}, \i{upstream}, \i{prerel}, \i{revision}, and finally, \i{iteration}. The \i{upstream} and \i{prerel} parts are compared from left to right, one component at a time, as described next.  To compare two components, first the component types are determined.  A component that only consists of digits is an integer. Otherwise, it is a string. If both components are integers, then they are compared as integers. Otherwise, they are compared lexicographically and case-insensitively. \N{The reason for case-insensitive comparison is Windows file names.}  A non-existent component is considered 0 if the other component is an integer and an empty string if the other component is a string.  For example, in \c{1.2} vs \c{1.2.0}, the third component in the first version is 0 and the two versions are therefore equal. As a special exception to this rule, an absent \i{prerel} part is always greater than any non-absent part. \N{And thus making the final release always older than any pre-release.}  This algorithm gives correct results for most commonly-used versioning schemes, for example:  \ 1.2.3 < 12.2 1.alpha < 1.beta 20151128 < 20151228 2015.11.28 < 2015.12.28 \  One notable versioning scheme where this approach gives an incorrect result is hex numbers (consider \c{A} vs \c{1A}). The simplest work around is to convert such numbers to decimal. Alternatively, one can fix the width of the hex number and pad all the values with leading zeros, for example: \c{00A} vs \c{01A}.  It is also possible to convert the \i{upstream} and \i{prerel} parts into a \i{canonical representation} that will produce the correct comparison result when always compared lexicographically and as a whole. \N{This can be useful, for example, when storing versions in the database which would otherwise require a custom collation implementation to obtain the correct sort order.}  To convert one of these parts to its canonical representation, all its string components are converted to the lower case while all its integer components are padded with leading zeros to the fixed length of \c{16} characters, with all trailing zero-only components removed. Note that this places an implementation limit on the length of integer components which should be checked by the implementation when converting to the canonical representation. \N{The \c{16} characters limit was chosen to still be able to represent (with some spare) components in the \i{YYYYMMDDhhmmss} form while not (visually) bloating the database too much.} As a special case, the absent \i{prerel} part is represented as \c{~}. \N{Since the ASCII code for \c{~} is greater than any other character that could appear in \i{prerel}, such a string will always be greater than any other representation.} The empty \i{prerel} part is represented as an empty string.  Note that because it is no possible to perform a reverse conversion without the possibility of loss (consider \c{01.AA.BB}), the original parts may also have to be stored, for example, for display, to derive package archive names, etc.  \N|In quite a few contexts the implementation needs to ignore the \i{revision} and/or \i{iteration} parts. For example, this is needed to implement the semantics of newer revisions/iterations of packages replacing their old ones since we do not keep multiple revisions/iterations of the same upstream version in the same respository. As a result, in the package object model, we have a version key as just {\i{epoch}, \i{upstream}, \i{prerel}} but also store the package revision and iteration so that it can be shown it to the user, etc.|   \h1#package-version-constraint|Package Version Constraint|  The \c{bpkg} package version constraint may follow the package name in certain contexts, such as the manifest values and \c{bpkg} command line, to restrict the allowed package version set. It can be specified using comparison operators, shortcut (to range) operators, or ranges and has the following form:  \  :=  |  |           := ('==' | '>' | '<' | '>=' | '<=')             := ('^' | '~')                := ('(' | '[')   (')' | ']') \  The shortcut operators can only be used with \l{b#module-version standard versions} (a semantic version without the pre-release part is a standard version). They are equivalent to the following ranges. \N{The \c{X.Y.Z-} version signifies the earliest pre-release in the \c{X.Y.Z} series; see \l{#package-version Package Version} for details}.  \ ~X.Y.Z  [X.Y.Z  X.Y+1.0-)  ^X.Y.Z  [X.Y.Z  X+1.0.0-)  if X >  0 ^0.Y.Z  [0.Y.Z  0.Y+1.0-)  if X == 0 \  That is, the tilde (\c{~}) constraint allows upgrades to any further patch version while the caret (\c{^}) constraint \- also to any further minor version.  \N|Zero major version component is customarily used during early development where the minor version effectively becomes major. As a result, the tilde constraint has special semantics for this case.|  Note that the shortuct operators can only be used with the complete, three-component versions (\c{X.Y.Z} with the optional pre-release part per the standard version). Specifically, there is no support for special \c{^X.Y} or \c{~X} semantics offered by some package manager \- if desired, such functionality can be easily achieved with ranges. Also, the \c{0.0.Z} version is not considered special except as having zero major component for the tilde semantics discussed above.  Note also that pre-releases do not required any special considerations when used with the shortcut operators. For example, if package \c{libfoo} is usable starting with the second beta of the \c{2.0.0} release, then our constraint could be expressed as:  \ libfoo ^2.0.0-b.2 \  \N|Internally shortucts and comparisons can be represented as ranges (that is, \c{[v, v]} for \c{==}, \c{(v, inf)} for \c{>}, etc). However, for display and serialization such representations should be converted back to simple operators. While it is possible that the original manifest specified equality or shortucts as full ranges, it is acceptable to display/serialize them as simpler operators.|   \h1#manifests|Manifests|  This chapter describes the general manifest file format as well as the concrete manifests used by \c{bpkg}.  Currently, three manifests are defined: package manifest, repository manifest, and signature manifest. The former two manifests can also be combined into a list of manifests to form the list of available packages and the description of a repository, respectively.  \h#manifest-format|Manifest Format|  The manifest format is a UTF-8 encoded text containing a list of name-value pairs in the form:  \ :  \  For example:  \ name: libfoo version: 1.2.3 \  The name can contain any characters except \c{:} and whitespaces. Newline terminates the pair unless escaped with \c{\\} (see below). Leading and trailing whitespaces before and after name and value are ignored except in the multi-line mode (see below).  If, the first non-whitespace character on the line is \c{#}, then the rest of the line is treated as a comment and ignored except if the preceding newline was escaped or in the multi-line mode (see below). For example:  \ # This is a comment. short: This is #not a comment long: Also \ #not a comment \  The first name-value pair in the manifest file should always have an empty name. The value of this special pair is the manifest format version. The version value shall use the default (that is, non-multi-line) mode and shall not use any escape sequences. Currently it should be \c{1}, for example:  \ : 1 name: libfoo version: 1.2.3 \  Any new name that is added without incrementing the version must be optional so that it can be safely ignored by older implementations.  The special empty name pair can also be used to separate multiple manifests. In this case the version may be omitted in the subsequent manifests, for example:  \ : 1 name: libfoo version: 1.2.3 : name: libbar version: 2.3.4 \  To disable treating of a newline as a name-value pair terminator we can escape it with \c{\\}. Note that \c{\\} is only treated as an escape sequence when followed by a newline and both are simply removed from the stream (as opposed to being replaced which a space). To enter a literal \c{\\} at the end of the value, use the \c{\\\\} sequence. For example:  \ description: Long text that doesn't fit into one line \ so it is continued on the next line. \  \ windows-path: C:\foo\bar\\\\ \  Notice that in the final example only the last \c{\\} needs special handling since it is the only one that is followed by a newline.  One may notice that in this newline escaping scheme a line consisting of just \c{\\} followed by a newline has no use, except, perhaps, for visual presentation of, arguably, dubious value. For example, this representation:  \ description: First line. \ \\ Second line. \  Is semantically equivalent to:  \ description: First line. Second line. \  As a result, such a sequence is \"overloaded\" to provide more useful functionality in two ways: Firstly, if \c{:} after the name is immediately followed (ignoring whitespaces) by \c{\\} and a newline, then it signals the start of the multi-line mode. In this mode all subsequent newlines and \c{#} are treated as ordinary characters rather than value terminators or comments until a line consisting of just \\ and a newline (the multi-line mode terminator). For example:  \ description:\ First paragraph. # Second paragraph. \\ \  Expressed as a C-string, the value in the above example is:  \ \"First paragraph.\n#\nSecond paragraph.\" \   \N|If we didn't expect to ever need to specify a name with an empty value, then an empty value could have turned on the multi-line mode, for example:  \ description: First paragraph. # Second paragraph. \\ \  There are two reasons we don't do this: we don't want to close the door on empty values and we want a more explicit \"introductor\" for the multi-line mode since it is quite different compared to the simple mode.|  Note that in the multi-line mode we can still use newline escaping to split long lines, for example:  \ description:\ First paragraph that doesn't fit into one line \ so it is continued on the next line. Second paragraph. \\ \  In the simple (that is, non-multi-line) mode, the sole \c{\\} and newline sequence is overloaded to mean a newline. So the previous example can also be represented like this:  \ description: First paragraph that doesn't fit into one \ line so it is continued on the next line.\ \\ Second paragraph. \  Note that the multi-line mode can be used to capture a value with leading and/or trailing whitespaces, for example:  \ description:\   test  \\ \  The C-string representing this value is:  \ \"  test\n\" \  EOF can be used instead of a newline to terminate both simple and multi-line values. For example the following representation results in the same value as in the previous example.  \ description:\   test   \  By convention, names are all in lower case and multi-word names are separated with \c{-}. Note that names are case-sensitive.  Also by convention, the following name suffixes are used to denote common types of values:  \ -file -url -email \  For example:  \ description: Inline description description-file: README package-url: http://www.example.com package-email: john@example.com \  Other common name suffixes (such as -feed) could be added later.  \N|Generally, unless there is a good reason not to, we keep values lower-case (for example, \c{requires} values such as \c{c++11} or \c{linux}). An example where we use upper/mixed case would be \c{license}; it seems unlikely \c{gplv2} would be better than \c{GPLv2}.|  A number of name-value pairs described below allow for the value proper to be optionally followed by \c{;} and a comment. Such comments serve as additional documentation for the user and should be full sentence(s), that is start with a capital letter and end with a period. Note that unlike \c{#}-style comments which are ignored, these comments are considered to be part of the value. For example:  \ email: foo-users@example.com ; Public mailing list. \  It is recommended that you keep comments short, single-sentence. Note that non-comment semicolons in such values have to be escaped with a backslash, for example:  \ url: http://git.example.com/?p=foo\;a=tree \  In the manifest specifications described below optional components are enclosed in square brackets (\c{[]}). If the name is enclosed in \c{[]} then the name-value pair is optional, otherwise \- required. For example:  \ name:  license:  [; ] [description]:  \  In the above example \c{name} is required, \c{license} has an optional component (comment), and \c{description} is optional.  In certain situations (for example, shell scripts) it can be easier to parse the binary manifest representation. The binary representation does not include comments and consists of a sequence of name-value pairs in the following form:  \ :\0 \  That is, the name and the value are separated by a colon and each pair (including the last) is terminated with the \c{NUL} character. Note that there can be no leading or trailing whitespace characters around the name and any whitespaces after the colon and before the \c{NUL} terminator are part of the value. Finally, the manifest format versions are always explicit (that is, not empty) in binary manifest lists.   \h#manifest-package|Package Manifest|  The package manifest (the \c{manifest} file found in the package's root directory) describes a \c{bpkg} package. The manifest synopsis is presented next followed by the detailed description of each value in subsequent sections.  The subset of the values up to and including \c{license} constitute the package manifest header. Note that the header is a valid package manifest since all the other values are optional. There is also no requirement for the header values to appear first or to be in a specific order. In particular, in a full package manifest they can be interleaved with non-header values.  \ name:  version:  [project]:  [priority]:  [; ] summary:  license:  [; ] \  \ [topics]:  [keywords]:  [description]:  [description-file]:  [; ] [description-type]:  [changes]:  [changes-file]:  [; ]  [url]:  [; ] [doc-url]:  [; ] [src-url]:  [; ] [package-url]:  [; ]  [email]:  [; ] [package-email]:  [; ] [build-email]:  [; ] [build-warning-email]:  [; ] [build-error-email]:  [; ]  [depends]: [?][*]  [; ] [requires]: [?] [] [; ]  [tests]:  [] [examples]:  [] [benchmarks]:  []  [builds]:  [; ] [build-include]: [/] [; ] [build-exclude]: [/] [; ] \  \h2#manifest-package-name|\c{name}|  \ name:  \  The package name. See \l{#package-name Package Name} for the package name format description. Note that the name case is preserved for display, in file names, etc.   \h2#manifest-package-version|\c{version}|  \ version:  [upstream-version]:  \  The package version. See \l{#package-version Package Version} for the version format description. Note that the version case is preserved for display, in file names, etc.  When packaging existing projects, sometimes you may want to deviate from the upstream versioning scheme because, for example, it may not be representable as a \c{bpkg} package version or simply be inconvenient to work with. In this case you would need to come up with an upstream-to-downstream version mapping and use the \c{upstream-version} value to preserve the original version for information.   \h2#manifest-package-project|\c{project}|  \ [project]:  \  The project this package belongs to. The project name has the same restrictions as the package name (see \l{#package-name Package Name} for details) and its case is preserved for display, in directory names, etc. If unspecified, then the project name is assumed to be the same as the package name.  Projects are used to group related packages together in order to help with organization and discovery in repositories. For example, packages \c{hello}, \c{libhello}, and \c{libhello2} could all belong to project \c{hello}. By convention, projects of library packages are named without the \c{lib} prefix.   \h2#manifest-package-|\c{priority}|  \ [priority]:  [; ]   = security | high | medium | low \  The release priority (optional). As a guideline, use \c{security} for security fixes, \c{high} for critical bug fixes, \c{medium} for important bug fixes, and \c{low} for minor fixes and/or feature releases. If not specified, \c{low} is assumed.   \h2#manifest-package-summary|\c{summary}|  \ summary:  \  The short description of the package.   \h2#manifest-package-license|\c{license}|  \ license:  [; ]   =  [, ]* \  The package license. The format is a comma-separated list of case-insensitive license names under which this package is distributed. This list has the \i{AND} semantics, that is, the user must comply with all the licenses listed. To capture alternative licensing options use multiple \c{license} values, for example:  \ license: LGPLv2.1, MIT license: BSD3 \  In the above example, the package can be used either under the BSD3 license or both LGPLv2.1 and MIT.  For complex licensing schemes it is recommended to add comments as an aid to the user, for example:  \ license: LGPLv2.1, MIT ; If linking with GNU TLS. license: BSD3          ; If linking with OpenSSL. \  To assist automated processing, the following pre-defined names should be used for the common licenses:  \ MIT          ; MIT License. BSD2         ; Simplified 2-clause BSD License. BSD3         ; New 3-clause BSD License. BSD4         ; Original 4-clause BSD License. GPLv2        ; GNU General Public License v2.0. GPLv3        ; GNU General Public License v3.0. LGPLv2       ; GNU Lesser General Public License v2.0. LGPLv2.1     ; GNU Lesser General Public License v2.1. LGPLv3       ; GNU Lesser General Public License v3.0. AGPLv2       ; Affero General Public License v2.0. AGPLv3       ; GNU Affero General Public License v3.0. ASLv1        ; Apache License v1.0. ASLv1.1      ; Apache License v1.1. ASLv2        ; Apache License v2.0. MPLv2        ; Mozilla Public License v2.0.  public domain available source ; Not free software/open source. proprietary TODO             ; License is not yet decided. \  Note that just \c{BSD} is ambiguous and should be avoided.  \N|An example of automated processing would be filtering for non-copyleft licensed packages.|   \h2#manifest-package-topics|\c{topics}|  \ [topics]:    =  [, ]* \  The package topics (optional). The format is a comma-separated list of up to five potentially multi-word concepts that describe this package. For example:  \ topics: xml parser, xml serializer \   \h2#manifest-package-keywords|\c{keywords}|  \ [keywords]:    =  [ ]* \  The package keywords (optional). The format is a space-separated list of up to five words that describe this package. Note that the package and project names as well as words from its summary are already considered to be keywords and need not be repeated in this value.   \h2#manifest-package-description|\c{description}|  \ [description]:  [description-file]:  [; ] [description-type]:  \  The detailed description of the package. It can be provided either inline as a text fragment or by referring to a file within a package (e.g., \c{README}), but not both.  In the web interface (\c{brep}) the description is displayed according to its type. Currently, pre-formatted plain text, \l{https://github.github.com/gfm GitHub-Flavored Markdown}, and \l{https://spec.commonmark.org/current CommonMark} are supported with the following \c{description-type} values, respectively:  \ text/plain text/markdown;variant=GFM text/markdown;variant=CommonMark \  If just \c{text/markdown} is specified, then the GitHub-Flavored Markdown (which is a superset of CommonMark) is assumed.  If the description type is not explicitly specified and the description is specified as \c{description-file}, then an attempt to derive the type from the file extension is made. Specifically, the \cb{.md} and \cb{.markdown} extensions are mapped to \c{text/markdown}, the \cb{.txt} and no extension are mapped to \c{text/plain}, and all other extensions are treated as an unknown type, similar to unknown \c{description-type} values. And if the description is not specified as a file, \c{text/plain} is assumed.   \h2#manifest-package-changes|\c{changes}|  \ [changes]:  [changes-file]:  [; ] \  The description of changes in the release.  \N|The tricky aspect is what happens if the upstream release stays the same (and has, say, a \c{NEWS} file to which we point) but we need to make another package release, for example, to apply a critical patch.|  Multiple \c{changes} values can be present which are all concatenated in the order specified, that is, the first value is considered to be the most recent (similar to \c{ChangeLog} and \c{NEWS} files). For example:  \ changes: 1.2.3-2: applied upstream patch for critical bug bar changes: 1.2.3-1: applied upstream patch for critical bug foo changes-file: NEWS \  Or:  \ changes:\ 1.2.3-2   - applied upstream patch for critical bug bar   - regenerated documentation  1.2.3-1   - applied upstream patch for critical bug foo \\ changes-file: NEWS \  In the web interface (\c{brep}) the changes are displayed as pre-formatted plain text, similar to the package description.   \h2#manifest-package-url|\c{url}|  \ [url]:  [; ] \  The project home page URL.   \h2#manifest-package-doc-url|\c{doc-url}|  \ [doc-url]:  [; ] \  The project documentation URL.   \h2#manifest-package-src-url|\c{src-url}|  \ [src-url]:  [; ] \  The project source repository URL.   \h2#manifest-package-package-url|\c{package-url}|  \ [package-url]:  [; ] \  The package home page URL. If not specified, then assumed to be the same as \c{url}. It only makes sense to specify this value if the project and package are maintained separately.   \h2#manifest-package-email|\c{email}|  \ [email]:  [; ] \  The project email address. For example, a support mailing list.   \h2#manifest-package-package-email|\c{package-email}|  \ [package-email]:  [; ] \  The package email address. If not specified, then assumed to be the same as \c{email}. It only makes sense to specify this value if the project and package are maintained separately.   \h2#manifest-package-build-email|\c{build-email}|  \ [build-email]:  [; ] \  The build notification email address. It is used to send build result notifications by automated build bots. If none of the \c{build-*email} values are specified, then it is assumed to be the same as \c{package-email}. If it is specified but empty, then no build result notifications for this package are sent by email.   \h2#manifest-package-warning-email|\c{build-warning-email}|  \ [build-warning-email]:  [; ] \  The build warning notification email address. Unlike \c{build-email}, only build warning and error notifications are sent to this email.   \h2#manifest-package-error-email|\c{build-error-email}|  \ [build-error-email]:  [; ] \  The build error notification email address. Unlike \c{build-email}, only build error notifications are sent to this email.   \h2#manifest-package-depends|\c{depends}|  \ [depends]: [?][*]  [; ]   :=  [ '|' ]*    :=  [] \  The prerequisite packages. If the \c{depends} value start with \c{*}, then it is a \i{build-time} prerequisite. Otherwise it is \i{run-time}.  \N|Most of the build-time prerequisites are expected to be tools such as code generator, so you can think of \c{*} as the executable mark printed by \c{ls}. An important difference between the two kind of dependencies is that in case of cross-compilation a build-time dependency must be built for the build machine, not the target.|  Two special build-time dependency names are recognized and checked in an ad hoc manner: \c{build2} (the \c{build2} build system) and \c{bpkg} (the \c{build2} package manager). This allows us to specify the required build system and package manager versions, for example:  \ depends: * build2 >= 0.6.0 depends: * bpkg >= 0.6.0 \  Each \c{depends} value can specify multiple packages with the \i{OR} semantics. While multiple \c{depends} values are used to specify multiple packages with the \i{AND} semantics. A value that starts with \c{?} is a conditional prerequisite. Whether such a prerequisite will be in effect can only be determined at the package configuration time. It is recommended that you provide a comment for each conditional prerequisite as an aid to the user. For example:  \ depends: libz depends: libfoo ~1.2.0 ; Only works with libfoo 1.2.*. depends: libgnutls >= 1.2.3 | libopenssl >= 2.3.4 depends: ? libboost-regex >= 1.52.0 ; Only if no C++11 . depends: ? libqtcore >= 5.0.0 ; Only if GUI is enabled. \  It is recommended that you specify unconditional dependencies first with simple (no alternatives) dependencies leading each set.  See \l{#package-version-constraint Package Version Constraint} for the format and semantics of the optional version constraint. Instead of a concrete value, it can also be specified in terms of the dependent package's version (that is, its \l{#manifest-package-version \c{version}} value) using the special \c{$} value. A \c{depends} value that contains \c{$} is called incomplete. This mechanism is primarily useful when developing related packages that should track each other's versions exactly or closely. For example:  \ name: sqlite3 version: 3.18.2 depends: libsqlite3 == $\ In comparison operators and ranges the \c{$} value is replaced with the dependent version ignoring the revision. For shortcut operators, the dependent version must be a standard version and the following additional processing is applied depending on whether the version is a release, final pre-release, or a snapshot pre-release.  \ol|  \li|For a release we set the min version patch to zero. For \c{^} we also set the minor version to zero, unless the major version is zero (reduces to \c{~}). The max version is set according to the standard shortcut logic. For example, \c{~$} is completed as follows: \ 1.2.0 -> [1.2.0 1.3.0-) 1.2.1 -> [1.2.0 1.3.0-) 1.2.2 -> [1.2.0 1.3.0-) \ And \c{^$} is completed as follows:  \ 1.0.0 -> [1.0.0 2.0.0-) 1.1.1 -> [1.0.0 2.0.0-) \  |  \li|For a final pre-release the key observation is that if the patch component for \c{~} or minor and patch components for \c{^} are not zero, then that means there has been a compatible release and we treat this case the same as release, ignoring the pre-release part. If, however, it/they are zero, then that means there may yet be no final release and we have to start from the first alpha. For example, for the \c{~$} case: \ 1.2.0-a.1 -> [1.2.0-a.1 1.3.0-) 1.2.0-b.2 -> [1.2.0-a.1 1.3.0-) 1.2.1-a.1 -> [1.2.0 1.3.0-) 1.2.2-b.2 -> [1.2.0 1.3.0-) \ And for the \c{^$} case:  \ 1.0.0-a.1 -> [1.0.0-a.1 2.0.0-) 1.0.0-b.2 -> [1.0.0-a.1 2.0.0-) 1.0.1-a.1 -> [1.0.0     2.0.0-) 1.1.0-b.2 -> [1.0.0     2.0.0-) \  |  \li|For a snapshot pre-release we distinguish two cases: a patch snapshot (the patch component is not zero) and a major/minor snapshot (the patch component is zero). For the patch snapshot case we assume that it is (most likely) developed independently of the dependency and we treat it the same as the final pre-release case. For example, if the dependent version is \c{1.2.1-a.0.nnn}, the dependency could be \c{1.2.0} or \c{1.2.2} (or somewhere in-between).  For the major/minor snapshot we assume that all the packages are developed in the lockstep and have the same \c{X.Y.0} version. In this case we make the range start from the earliest possible version in this \"snapshot series\" and end before the final pre-release. For example (in this case \c{~} and \c{^} are treated the same):  \ 1.2.0-a.0.nnn -> [1.2.0-a.0.1 1.2.0-a.1) 2.0.0-b.2.nnn -> [2.0.0-b.2.1 2.0.0-b.3) \  ||   \h2#manifest-package-requires|\c{requires}|  \ [requires]: [?] [] [; ]   :=  [ '|' ]*   :=  |  \  The package requirements (other than other packages). Such requirements are normally checked during package configuration by the build system and the only purpose of capturing them in the manifest is for documentation. Similar to \c{depends}, a value that starts with \c{?} is a conditional requirement. For example:  \ requires: linux | windows | macosx requires: c++11 requires: ? ; VC 15 or later if targeting Windows. requires: ? ; libc++ if using Clang on Mac OS. \  Notice that in the last two cases the id is omitted altogether with only the comment specifying the requirement.  Note that \c{requires} should also be used to specify dependencies on external libraries, that is, the ones not packaged or not in the repository. In this case it may make sense to also specify the version constraint. For example:  \ requires: zlib >= 1.2.0 ; Most systems already have it or get from zlib.net. \  It is recommended that you specify unconditional requirements first with simple (no alternatives) requirements leading each set.  To assist automated processing, the following pre-defined ids should be used for the common requirements:  \ c++98 c++03 c++11 c++14 c++17 c++20 c++23 \  \ posix linux macos freebsd windows \  \ gcc[_X.Y.Z]  ; For example: gcc_6, gcc_4.9, gcc_5.0.0 clang[_X.Y]  ; For example: clang_6, clang_3.4, clang_3.4.1 msvc[_NU]    ; For example: msvc_14, msvc_15u3 \   \h2#manifest-package-tests-examples-benchmarks|\c{tests, examples, benchmarks}|  \ [tests]:  [] [examples]:  [] [benchmarks]:  [] \  Separate tests, examples, and benchmarks packages. These packages are built and tested by automated build bots together with the dependent package (see the \c{bbot} documentation for details). This, in particular, implies that these packages must be available from the dependent package's repository or its complement repositories, recursively. The recommended naming convention for these packages is the dependent package name followed with \c{-tests}, \c{-examples}, or \c{-benchmarks}, respectively. For example:  \ name: hello tests : hello-tests examples: hello-examples \  See \l{#package-version-constraint Package Version Constraint} for the format and semantics of the optional version constraint. Instead of a concrete value, it can also be specified in terms of the dependent package's version (see the \l{#manifest-package-depends \c{depends}} value for details), for example:  \ tests: hello-tests ~\$ \   \h2#manifest-package-builds|\c{builds}|  \ [builds]: [ ':' ] [] [; ]   :=  [ ]*  :=  [ ]*  := ('+'|'-'|'&')['!']( | '('  ')') \  The package build configurations. They specify the build configuration classes the package should or should not be built for by automated build bots. For example:  \ builds: -windows \  Build configurations can belong to multiple classes with their names and semantics varying between different build bot deployments. However, the pre-defined \c{none}, \c{default}, and \c{all} classes are always provided. If no \c{builds} value is specified in the package manifest, then the \c{default} class is assumed.  \N|A build configuration class can also derive from another class in which case configurations that belong to the derived class are treated as also belonging to the base class (or classes, recursively). See the Build Configurations page of the build bot deployment for the list of available build configurations and their classes.|  The \c{builds} value consists of an optional underlying class set (\c{}) followed by a class set expression (\c{}). The underlying set is a space-separated list of class names that define the set of build configurations to consider. If not specified, then all the configurations belonging to the \c{default} class are assumed. The class set expression can then be used to exclude certain configurations from this initial set.  The class expression is a space-separated list of terms that are evaluated from left to right. The first character of each term determines whether the build configuration that belong to its set are added to (\c{+}), subtracted from (\c{-}), or intersected with (\c{&}) the current set. If the second character in the term is \c{!}, then its set of configuration is inverted against the underlying set. The term itself can be either the class name or a parenthesized expression. Some examples:  \ builds: none                     ; None. builds: all                      ; All. builds: default legacy           ; Default and legacy. builds: -windows                 ; Default except Windows. builds: all : -windows           ; All except Windows. builds: all : &gcc               ; All with GCC only. builds: all : &gcc-8+            ; All with GCC 8 and up only. builds: gcc : -optimized         ; GCC without optimization. builds: gcc : &( +linux +macos ) ; GCC on Linux or Mac OS. \  Notice that the colon and parentheses must be separated with spaces from both preceding and following terms.  Multiple \c{builds} values are evaluated in the order specified and as if they were all part of a single expression. Only the first value may specify the underlying set. The main reason for having multiple values is to provide individual reasons (as the \c{builds} value comments) for different parts of the expression. For example:  \ builds: default experimental ; Only modern compilers are supported. builds: -gcc                 ; GCC is not supported. builds: -clang               ; Clang is not supported. \  \N|The \c{builds} value comments are used by the web interface (\c{brep}) to display the reason for the build configuration exclusion.|  After evaluating all the \c{builds} values, the final configuration set can be further fine-tuned using the \l{#manifest-package-include-exclude \c{build-{include, exclude\}}} patterns.   \h2#manifest-package-include-exclude|\c{build-{include, exclude\}}|  \ [build-include]: [/] [; ] [build-exclude]: [/] [; ] \  The package build inclusions and exclusions. The \c{build-include} and \c{build-exclude} values further reduce the configuration set produced by evaluating the \l{#manifest-package-builds \c{builds}} values. The \i{config} and \i{target} values are filesystem wildcard patterns which are matched against the build configuration names and target names (see the \c{bbot} documentation for details). In particular, the \c{*} wildcard matches zero or more characters within the name component while the \c{**} sequence matches across the components. Plus, wildcard-only pattern components match absent name components. For example:  \ build-exclude: windows**     # matches windows_10-msvc_15 build-exclude: macos*-gcc**  # matches macos_10.13-gcc_8.1-O3 build-exclude: linux-gcc*-*  # matches linux-gcc_8.1 and linux-gcc_8.1-O3 \  The exclusion and inclusion patterns are applied in the order specified with the first match determining whether the package will be built for this configuration and target. If none of the patterns match (or none we specified), then the package is built.  As an example, the following value will exclude 32-bit builds for the MSVC 14 compiler:  \ build-exclude: *-msvc_14**/i?86-** ; Linker crash. \  As another example, the following pair of values will make sure that a package is only built on Linux:  \ build-include: linux** build-exclude: ** ; Only supported on Linux. \  Note that the comment of the matching exclusion is used by the web interface (\c{brep}) to display the reason for the build configuration exclusion.   \h#manifest-package-list-pkg|Package List Manifest for \cb{pkg} Repositories|  The package list manifest (the \c{packages.manifest} file found in the \cb{pkg} repository root directory) describes the list of packages available in the repository. First comes a manifest that describes the list itself (referred to as the list manifest). The list manifest synopsis is presented next:  \ sha256sum:  \  After the list manifest comes a (potentially empty) sequence of package manifests. These manifests shall not contain any \c{*-file} or incomplete \l{#manifest-package-depends \c{depends}} values (such values should be converted to their inline versions or completed, respectively) but must contain the following additional (to package manifest) values:  \ location:  sha256sum:  \  The detailed description of each value follows in the subsequent sections.  \h2#manifest-package-list-pkg-sha256sum|\c{sha256sum} (list manifest)|  \ sha256sum:  \  The SHA256 checksum of the \c{repositories.manifest} file (described below) that corresponds to this repository. The \i{sum} value should be 64 characters long (that is, just the SHA256 value, no file name or any other markers), be calculated in the binary mode, and use lower-case letters.  \N|This checksum is used to make sure that the \c{repositories.manifest} file that was fetched is the same as the one that was used to create the \c{packages.manifest} file. This also means that if \c{repositories.manifest} is modified in any way, then \c{packages.manifest} must be regenerated as well.|  \h2#manifest-package-list-pkg-package-location|\c{location} (package manifest)|  \ location:  \  The path to the package archive file relative to the repository root. It should be in the POSIX representation.  \N|if the repository keeps multiple versions of the package and places them all into the repository root directory, it can get untidy. With \c{location} we allow for sub-directories.|   \h2#manifest-package-list-pkg-package-sha256sum|\c{sha256sum} (package manifest)|  \ sha256sum:  \  The SHA256 checksum of the package archive file. The \i{sum} value should be 64 characters long (that is, just the SHA256 value, no file name or any other markers), be calculated in the binary mode, and use lower-case letters.   \h#manifest-package-list-dir|Package List Manifest for \cb{dir} Repositories|  The package list manifest (the \c{packages.manifest} file found in the \cb{dir} repository root directory) describes the list of packages available in the repository. It is a (potentially empty) sequence of manifests with the following synopsis:  \ location:  [fragment]:  \  The detailed description of each value follows in the subsequent sections. The \c{fragment} value can only be present in a merged \c{packages.manifest} file for a multi-fragment repository.  As an example, if our repository contained the \c{src/} subdirectory that in turn contained the \c{libfoo} and \c{foo} packages, then the corresponding \c{packages.manifest} file could look like this:  \ : 1 location: src/libfoo/ : location: src/foo/ \  \h2#manifest-package-list-dir-location|\c{location}|  \ location:  \  The path to the package directory relative to the repository root. It should be in the POSIX representation.   \h2#manifest-package-list-dir-fragment|\c{fragment}|  \ [fragment]:  \  The repository fragment id this package belongs to.   \h#manifest-repository|Repository Manifest|  The repository manifest (only used as part of the repository manifest list described below) describes a \cb{pkg}, \cb{dir}, or \cb{git} repository. The manifest synopsis is presented next followed by the detailed description of each value in subsequent sections.  \ [location]:  [type]: pkg|dir|git [role]: base|prerequisite|complement [trust]:  [url]:  [email]:  [; ] [summary]:  [description]:  [certificate]:  [fragment]:  \  See also the Repository Chaining documentation for further information @@ TODO.  \h2#manifest-repository-location|\c{location}|  \ [location]:  \  The repository location. The location can only and must be omitted for the base repository. \N{Since we got hold of its manifest, then we presumably already know the location of the base repository.} If the location is a relative path, then it is treated as relative to the base repository location.  For the \cb{git} repository type the relative location does not inherit the URL fragment from the base repository. Note also that the remote \cb{git} repository locations normally have the \cb{.git} extension that is stripped when a repository is cloned locally. To make the relative locations usable in both contexts, the \cb{.git} extension should be ignored if the local prerequisite repository with the extension does not exist while the one without the extension does.  While POSIX systems normally only support POSIX paths (that is, forward slashes only), Windows is generally able to handle both slash types. As a result, it is recommended that POSIX paths are always used in the \c{location} values, except, perhaps, if the repository is explicitly Windows-only by, for example, having a location that is an absolute Windows path with the drive letter. \N{The \cb{bpkg} package manager will always try to represent the location as a POSIX path and only fallback to the native representation if that is not possible (for example, there is a drive letter in the path).}   \h2#manifest-repository-type|\c{type}|  \ [type]: pkg|dir|git \  The repository type. The type must be omitted for the base repository. If the type is omitted for a prerequisite/complement repository, then it is guessed from its \c{location} value as described in \l{bpkg-rep-add(1)}.   \h2#manifest-repository-role|\c{role}|  \ [role]: base|prerequisite|complement \  The repository role. The \c{role} value can be omitted for the base repository only.   \h2#manifest-repository-trust|\c{trust}|  \ [trust]:  \  The repository fingerprint to trust. The \c{trust} value can only be specified for prerequisite and complement repositories and only for repository types that support authentication (currently only \c{pkg}). The \i{fingerprint} value should be an SHA256 repository fingerprint represented as 32 colon-separated hex digit pairs. \N{The repository in question is only trusted for use as a prerequisite or complement of this repository. If it is also used by other repositories or is added to the configuration by the user, then such uses cases are authenticated independently.}   \h2#manifest-repository-url|\c{url}|  \ [url]:  \  The repository's web interface (\c{brep}) URL. It can only be specified for the base repository (the web interface URLs for prerequisite/complement repositories can be extracted from their respective manifests).  For example, given the following \c{url} value:  \ url: https://example.org/hello/ \  The package details page for \c{libfoo} located in this repository will be \c{https://example.org/hello/libfoo}.  The web interface URL can also be specified as relative to the repository location (the \c{location} value). In this case \i{url} should start with two path components each being either \c{.} or \c{..}. If the first component is \c{..}, then the \c{www}, \c{pkg} or \c{bpkg} domain component, if any, is removed from the \c{location} URL host, just like when deriving the repository name.  Similarly, if the second component is \c{..}, then the \c{pkg} or \c{bpkg} path component, if any, is removed from the \c{location} URL path, again, just like when deriving the repository name.  Finally, the version component is removed from the \c{location} URL path, the rest (after the two \c{.}/\c{..} components) of the \c{url} value is appended to it, and the resulting path is normalized with all remaining \c{..}  and \c{.} applied normally.  For examples, assuming repository location is:  \ https://pkg.example.org/test/pkg/1/hello/stable \  The following listing shows some of the possible combinations (the \c{<>} marker is used to highlight the changes):  \ ./.          ->  https://pkg.example.org/test/pkg/hello/stable ../.         ->  https://<  >example.org/test/pkg/hello/stable ./..         ->  https://pkg.example.org/test/<  >hello/stable ../..        ->  https://<  >example.org/test/<  >hello/stable ././..       ->  https://pkg.example.org/test/pkg/hello<     > ../../../..  ->  https://<  >example.org/test<               > \  \N|The rationale for the relative web interface URLs is to allow deployment of the same repository to slightly different configuration, for example, during development, testing, and public use. For instance, for development we may use the \c{https://example.org/pkg/} setup while in production it becomes \c{https://pkg.example.org/}. By specifying the web interface location as, say, \c{../.}, we can run the web interface at these respective locations using a single repository manifest.|   \h2#manifest-repository-email|\c{email}|  \ [email]:  [; ] \  The repository email address. It must and can only be specified for the base repository. The email address is displayed by the web interface (\c{brep}) in the repository about page and could be used to contact the maintainers about issues with the repository.   \h2#manifest-repository-summary|\c{summary}|  \ [summary]:  \  The short description of the repository. It must and can only be specified for the base repository.   \h2#manifest-repository-description|\c{description}|  \ [description]:  \  The detailed description of the repository. It can only be specified for the base repository.  In the web interface (\c{brep}) the description is formatted into one or more paragraphs using blank lines as paragraph separators. Specifically, it is not represented as \c{
} so any kind of additional plain text formatting (for example, lists) will be lost and should not be used in the description.   \h2#manifest-repository-certificate|\c{certificate}|  \ [certificate]:  \  The X.509 certificate for the repository. It should be in the PEM format and can only be specified for the base repository. Currently only used for the \cb{pkg} repository type.  The certificate should contain the \c{CN} and \c{O} components in the subject as well as the \c{email:} component in the subject alternative names. The \c{CN} component should start with \c{name:} and continue with the repository name prefix/wildcard (without trailing slash) that will be used to verify the repository name(s) that are authenticated with this certificate. See \l{bpkg-repository-signing(1)} for details.  If this value is present then the \c{packages.manifest} file must be signed with the corresponding private key and the signature saved in the \c{signature.manifest} file. See \l{#manifest-signature-pkg Signature Manifest} for details.   \h2#manifest-repository-fragment|\c{fragment}|  \ [fragment]:  \  The repository fragment id this repository belongs to.   \h#manifest-repository-list|Repository List Manifest|  @@ TODO See the Repository Chaining document for more information on the terminology and semantics.  The repository list manifest (the \c{repositories.manifest} file found in the repository root directory) describes the repository. It is a sequence of repository manifests consisting of the base repository manifest (that is, the manifest for the repository that is being described) as well as manifests for its prerequisite and complement repositories. The individual repository manifests can appear in any order and the base repository manifest can be omitted.  The \c{fragment} values can only be present in a merged \c{repositories.manifest} file for a multi-fragment repository.  As an example, a repository manifest list for the \c{math/testing} repository could look like this:  \ # math/testing # : 1 email: math-pkg@example.org summary: Math package repository : role: complement location: ../stable : role: prerequiste location: https://pkg.example.org/1/misc/testing \  Here the first manifest describes the base repository itself, the second manifest \- a complement repository, and the third manifest \- a prerequisite repository. Note that the complement repository's location is specified as a relative path. For example, if the base repository location were:  \ https://pkg.example.org/1/math/testing \  Then the completement's location would be:  \ https://pkg.example.org/1/math/stable \   \h#manifest-signature-pkg|Signature Manifest for \cb{pkg} Repositories|  The signature manifest (the \c{signature.manifest} file found in the \cb{pkg} repository root directory) contains the signature of the repository's \c{packages.manifest} file. In order to detect the situation where the downloaded \c{signature.manifest} and \c{packages.manifest} files belong to different updates, the manifest contains both the checksum and the signature (which is the encrypted checksum). \N{We cannot rely on just the signature since a mismatch could mean either a split update or tampering.} The manifest synopsis is presented next followed by the detailed description of each value in subsequent sections.  \ sha256sum:  signature:  \  \h2#manifest-signature-pkg-sha256sum|\c{sha256sum}|  \ sha256sum:  \  The SHA256 checksum of the \c{packages.manifest} file. The \i{sum} value should be 64 characters long (that is, just the SHA256 value, no file name or any other markers), be calculated in the binary mode, and use lower-case letters.   \h2#manifest-signature-pkg-signature|\c{signature}|  \ signature:  \  The signature of the \c{packages.manifest} file. It should be calculated by encrypting the above \c{sha256sum} value with the repository certificate's private key and then \c{base64}-encoding the result. "  //@@ TODO items (grep). //@@ TODO: repository chaining, fix link in #manifest-repostiory. //@@ TODO: complete license list (MPL, ...) //@@ Are there any restrictions on requires ids? Is this valid: msvc >= 15u3?