Overview
| Comment: | Regenerate the documentation. |
|---|---|
| Downloads: | Tarball | ZIP archive | SQL archive |
| Timelines: | family | ancestors | descendants | both | trunk |
| Files: | files | file ages | folders |
| SHA1: |
2fa0ad12f08e7c0d17d669dadd9912de |
| User & Date: | mistachkin on 2019-11-06 16:08:17 |
| Other Links: | manifest | tags |
Context
|
2019-12-02
| ||
| 22:06 | Fix typos in the Harpy 'sign' tool. check-in: b2ec485564 user: mistachkin tags: trunk | |
|
2019-11-06
| ||
| 16:08 | Regenerate the documentation. check-in: 2fa0ad12f0 user: mistachkin tags: trunk | |
| 16:00 | Pickup 'common.tcl' fixes from upstream, mostly related to TLS handling. Unify variable override handling. Bump version. check-in: 0771035cd3 user: mistachkin tags: trunk | |
Changes
Modified doc/v1.html from [cef92c0427] to [c6c2976562].
1 2 | <div class="fossil-doc" data-title="Package Client Toolset API v1"><br> | | | 1 2 3 4 5 6 7 8 9 10 | <div class="fossil-doc" data-title="Package Client Toolset API v1"><br> <big><big><span style="font-family: monospace;">Public API Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/common.tcl&ln=227">::Eagle::Tools::Common::getFileViaHttp</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/common.tcl">common.tcl</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Required argument "uri"</span></big><br> <big><span style="font-family: monospace;"> Required argument "redirectLimit"</span></big><br> <big><span style="font-family: monospace;"> Required argument "channel"</span></big><br> |
| ︙ | ︙ | |||
29 30 31 32 33 34 35 | This procedure was stolen from the "common.tcl" script. This<br> procedure sets up the default values for all HTTP configuration<br> parameters used by this package. If the force argument is<br> non-zero, any existing values will be overwritten and set back<br> to their default values.<br> </blockquote><br><hr><br> | | | | | 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 | This procedure was stolen from the "common.tcl" script. This<br> procedure sets up the default values for all HTTP configuration<br> parameters used by this package. If the force argument is<br> non-zero, any existing values will be overwritten and set back<br> to their default values.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/common.tcl&ln=163">::Eagle::Tools::Common::pageOut</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/common.tcl">common.tcl</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Required argument "channel"</span></big><br> <big><span style="font-family: monospace;"> Required argument "string"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure was stolen from the "common.tcl" script. It is<br> designed to emit a message to the console. The channel argument<br> is the channel where the message should be written. The string<br> argument is the content of the message to emit. If the channel<br> argument is an empty string, nothing is written.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/common.tcl&ln=177">::Eagle::Tools::Common::pageLog</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/common.tcl">common.tcl</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Required argument "string"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure was stolen from the "common.tcl" script. It is<br> designed to emit a message to the HTTP client log. The string<br> argument is the content of the message to emit. If the string<br> argument is an empty string, nothing is written.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/common.tcl&ln=196">::Eagle::Tools::Common::pageProgress</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/common.tcl">common.tcl</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Required argument "channel"</span></big><br> <big><span style="font-family: monospace;"> Required argument "type"</span></big><br> <big><span style="font-family: monospace;"> Required argument "milliseconds"</span></big><br> |
| ︙ | ︙ | |||
362 363 364 365 366 367 368 369 370 371 372 373 374 375 | set back to their default values.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=210">::PackageDownloader::setupDownloadVars</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Required argument "script"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure sets up the default values for all configuration<br> parameters used by the package downloader client. The script<br> argument is the fully qualified path and file name for the script<br> being evaluated.<br> </blockquote><br><hr><br> | > > | 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 | set back to their default values.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle&ln=210">::PackageDownloader::setupDownloadVars</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Required argument "script"</span></big><br> <big><span style="font-family: monospace;"> Required argument "force"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure sets up the default values for all configuration<br> parameters used by the package downloader client. The script<br> argument is the fully qualified path and file name for the script<br> being evaluated.<br> </blockquote><br><hr><br> |
| ︙ | ︙ | |||
760 761 762 763 764 765 766 | This procedure evaluates the package repository client settings<br> script file, if it exists. Any script errors raised are not<br> masked. The script argument must be the fully qualified path<br> and file name for the primary package repository client script<br> file.<br> </blockquote><br><hr><br> | | | 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 | This procedure evaluates the package repository client settings<br> script file, if it exists. Any script errors raised are not<br> masked. The script argument must be the fully qualified path<br> and file name for the primary package repository client script<br> file.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Public API Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgr.eagle&ln=2530">::PackageRepository::getPackageFromRepository</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Required argument "package"</span></big><br> <big><span style="font-family: monospace;"> Required argument "version"</span></big><br> <big><span style="font-family: monospace;"> Required argument "caller"</span></big><br> |
| ︙ | ︙ | |||
1329 1330 1331 1332 1333 1334 1335 | script file, if it has been configured -AND- actually exists.<br> Any script errors raised are not masked. The evaluated script<br> file should (normally) modify the "::pkgr_api_keys" variable<br> in order to add API keys for use with the package repository<br> client.<br> </blockquote><br><hr><br> | | > > > | > | > > > | | > | | | | | | > > > | | > | > > > | > > | | | | | | | 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 | script file, if it has been configured -AND- actually exists.<br> Any script errors raised are not masked. The evaluated script<br> file should (normally) modify the "::pkgr_api_keys" variable<br> in order to add API keys for use with the package repository<br> client.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgr.eagle&ln=2297">::PackageRepository::setupRepositoryOpenPgpVars</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Required argument "force"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure sets up the default values for all configuration<br> parameters used to interact with the OpenPGP implementation.<br> If the force argument is non-zero, any existing values will be<br> overwritten and set back to their default values.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgr.eagle&ln=2417">::PackageRepository::setupPackageUnknownVars</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Required argument "force"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure sets up the default values for all configuration<br> parameters used by the package repository client. If the force<br> argument is non-zero, any existing values will be overwritten<br> and set back to their default values.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Internal API Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle&ln=1212">::PackageUploader::setupArgumentData</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Required argument "argv"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure initializes the array containing data derived from<br> the command line arguments, if any. The argv argument should be<br> the list of command line arguments.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Internal API Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle&ln=1287">::PackageUploader::haveArgumentData</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.eagle</a>")</span></big></big><br> <blockquote style="font-family: monospace;"><br> This procedure is used to determine if all the package submission<br> data is available. There are no arguments. Non-zero is returned<br> if all the package submission data is available. This procedure<br> should not raise script errors.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Internal API Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle&ln=1437">::PackageUploader::submitEventHandler</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Optional argument list "args"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure is an event handler. It handles the submit button in<br> both Tk and Eagle. It starts the package submission process. The<br> args argument is not really used, it is a placeholder to make this<br> procedure more portable between Tcl and Eagle. This procedure may<br> raise script errors.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Internal API Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle&ln=1580">::PackageUploader::setupWinFormsUserInterface</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.eagle</a>")</span></big></big><br> <blockquote style="font-family: monospace;"><br> This procedure creates the user interface for this tool using Eagle<br> and WinForms. The existing argument data, if any, will be used to<br> populate it. There are no arguments.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Internal API Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle&ln=1782">::PackageUploader::setupTkUserInterface</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.eagle</a>")</span></big></big><br> <blockquote style="font-family: monospace;"><br> This procedure creates the user interface for this tool using Tcl<br> and Tk. The existing argument data, if any, will be used to<br> populate it. There are no arguments.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle&ln=29">::PackageUploader::setupUploadVars</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Required argument "force"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure sets up the default values for all configuration<br> parameters used by the package uploader client. If the force<br> argument is non-zero, any existing values will be overwritten<br> and set back to their default values.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle&ln=233">::PackageUploader::setupCheckoutVars</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Required argument "force"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure sets up the default values for all configuration<br> parameters used by the package uploader client that require the<br> location of the checkout directory. If the force argument is<br> non-zero, any existing values will be overwritten and set back<br> to their default values.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle&ln=253">::PackageUploader::formatStringMapValue</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Required argument "value"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure returns a string value, formatted for use within a<br> script block being processed by the [string map] command. The<br> value argument is the string value to format. No return value is<br> reserved to indicate an error. This procedure may not raise any<br> script errors.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle&ln=273">::PackageUploader::countCommonPathParts</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Required argument "path1"</span></big><br> <big><span style="font-family: monospace;"> Required argument "path2"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure counts the common path components for two paths. The<br> count is returned, zero if there are no common path components. The<br> path1 and path2 arguments are the paths to compare. This procedure<br> may not raise script errors.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle&ln=301">::PackageUploader::getCommonContainingDirectory</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Required argument "fileNames"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure processes a list of (fully?) qualified file names and<br> tries to determine their common containing directory, if any. The<br> fileNames argument is the list of (fully?) qualified file names to<br> process. This procedure may not raise script errors. If there is<br> no common containing directory, an empty string is returned.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle&ln=347">::PackageUploader::getRelativeFileNames</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Required argument "fileNames"</span></big><br> <big><span style="font-family: monospace;"> Required argument "maximumLevels"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure attempts to process a list of (fully?) qualified file<br> names and return the corresponding list of relative file names. The<br> fileNames argument is the list of (fully?) qualified file names to<br> process. The maximumLevels argument is the maximum path depth that<br> is allowed for all file names. This procedure may raise script<br> errors.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle&ln=393">::PackageUploader::getScriptChunkForFileNames</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Required argument "fileNames"</span></big><br> <big><span style="font-family: monospace;"> Required argument "maximumLevels"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure attempts to create a script chunk that appends the<br> specified list of file names to a list variable. The fileNames<br> argument is the list of (fully?) qualified file names to append to<br> the list variable. The maximumLevels argument is the maximum path<br> depth that is allowed for all file names. This procedure may raise<br> script errors.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle&ln=427">::PackageUploader::createRepositoryScript</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Required argument "serverId"</span></big><br> <big><span style="font-family: monospace;"> Required argument "versionId"</span></big><br> <big><span style="font-family: monospace;"> Required argument "language"</span></big><br> |
| ︙ | ︙ | |||
1517 1518 1519 1520 1521 1522 1523 | strings "neutral", "win32-arm", "win32-x86", "win64-arm64",<br> "win64-ia64", or "win64-x64". The fileNames argument is the list of<br> (fully?) qualified file names to be downloaded when the associated<br> package is being provided. The options argument is reserved for<br> future use, it should be an empty list.<br> </blockquote><br><hr><br> | | | | | 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 | strings "neutral", "win32-arm", "win32-x86", "win64-arm64",<br> "win64-ia64", or "win64-x64". The fileNames argument is the list of<br> (fully?) qualified file names to be downloaded when the associated<br> package is being provided. The options argument is reserved for<br> future use, it should be an empty list.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle&ln=489">::PackageUploader::createMultipartFormData</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Required argument "boundary"</span></big><br> <big><span style="font-family: monospace;"> Required argument "request"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure creates textual data that conforms to the content<br> type "multipart/form-data", per RFC 2388. The boundary argument<br> is a boundary value, as specified in section 4.1 of the RFC. The<br> request argument is the dictionary of name/value pairs to include<br> in the form body. This procedure may not raise script errors.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle&ln=515">::PackageUploader::getSubmitUri</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.eagle</a>")</span></big></big><br> <blockquote style="font-family: monospace;"><br> This procedure returns the full URI to use when submitting a new<br> package to the package repository server. There are no arguments.<br> This procedure may raise script errors.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle&ln=555">::PackageUploader::submitPackageMetadata</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Required argument "apiKey"</span></big><br> <big><span style="font-family: monospace;"> Required argument "package"</span></big><br> <big><span style="font-family: monospace;"> Required argument "patchLevel"</span></big><br> |
| ︙ | ︙ | |||
1569 1570 1571 1572 1573 1574 1575 | string, "Tcl", or "Eagle". If it is an empty string, the current<br> language will be assumed. The script argument is the script to be<br> evaluated when the package needs to be provided. The certificate<br> argument is the certificate associated with the script, which may be<br> an OpenPGP signature or a Harpy script certificate.<br> </blockquote><br><hr><br> | | | | | | | | | | | | | | | | | | 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 | string, "Tcl", or "Eagle". If it is an empty string, the current<br> language will be assumed. The script argument is the script to be<br> evaluated when the package needs to be provided. The certificate<br> argument is the certificate associated with the script, which may be<br> an OpenPGP signature or a Harpy script certificate.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle&ln=654">::PackageUploader::getCheckoutId</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.eagle</a>")</span></big></big><br> <blockquote style="font-family: monospace;"><br> This procedure attempts to query the identifier of the Fossil<br> checkout. There are no arguments. An empty string is returned if<br> the information cannot be determined.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle&ln=697">::PackageUploader::getCheckoutDirectory</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.eagle</a>")</span></big></big><br> <blockquote style="font-family: monospace;"><br> This procedure attempts to query the root directory of the Fossil<br> checkout. There are no arguments. An empty string is returned if<br> the information cannot be determined.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle&ln=739">::PackageUploader::joinPath</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Optional argument list "args"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure builds a native path using the specified parts and<br> returns it. All arguments are considered to be parts of the path.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle&ln=749">::PackageUploader::verifyCheckoutDirectory</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.eagle</a>")</span></big></big><br> <blockquote style="font-family: monospace;"><br> This procedure attempts to verify that the root directory of the<br> Fossil checkout is present, valid, and is actually a directory.<br> There are no arguments. Script errors will be raised if any of<br> the checks fail.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle&ln=812">::PackageUploader::fossilMustBeInstalled</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.eagle</a>")</span></big></big><br> <blockquote style="font-family: monospace;"><br> This procedure attempts to verify that an implementation of Fossil<br> is installed locally. There are no arguments. Script errors are<br> raised if any problems are found. The return value is undefined.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle&ln=858">::PackageUploader::verifyThereAreNoChanges</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.eagle</a>")</span></big></big><br> <blockquote style="font-family: monospace;"><br> This procedure attempts to verify that the checkout directory does<br> not contain any (stray) changes. There are no arguments. Non-zero<br> is returned if the verification is successful.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle&ln=902">::PackageUploader::verifyThisIsTheCorrectProject</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.eagle</a>")</span></big></big><br> <blockquote style="font-family: monospace;"><br> This procedure attempts to verify that the checkout directory does<br> belong to the correct project. There are no arguments. Non-zero<br> is returned if the verification is successful.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle&ln=946">::PackageUploader::verifyThisIsTheCorrectBranch</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.eagle</a>")</span></big></big><br> <blockquote style="font-family: monospace;"><br> This procedure attempts to verify that the checkout directory does<br> belong to the correct branch. There are no arguments. Non-zero<br> is returned if the verification is successful.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle&ln=989">::PackageUploader::changeToTheCorrectBranch</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.eagle</a>")</span></big></big><br> <blockquote style="font-family: monospace;"><br> This procedure attempts to change the branch for the checkout<br> directory. There are no arguments. This procedure may raise<br> script errors.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle&ln=1026">::PackageUploader::stageOnePackageFile</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Required argument "targetDirectory"</span></big><br> <big><span style="font-family: monospace;"> Required argument "fileName"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure attempts to stage the specified package file using<br> Fossil. The targetDirectory argument is the fully qualified path<br> to the package platform directory. The fileName argument is the<br> relative name of the file to be staged. This procedure may raise<br> script errors.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle&ln=1061">::PackageUploader::stagePackageFiles</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Required argument "language"</span></big><br> <big><span style="font-family: monospace;"> Required argument "version"</span></big><br> <big><span style="font-family: monospace;"> Required argument "platform"</span></big><br> <big><span style="font-family: monospace;"> Required argument "fileNames"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure attempts to stage the specified package files using<br> Fossil. The fileNames argument is a list of (fully?) qualified<br> local file names to stage.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle&ln=1144">::PackageUploader::commitPackageFiles</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Required argument "package"</span></big><br> <big><span style="font-family: monospace;"> Required argument "patchLevel"</span></big><br> <big><span style="font-family: monospace;"> Required argument "language"</span></big><br> <big><span style="font-family: monospace;"> Required argument "version"</span></big><br> <big><span style="font-family: monospace;"> Required argument "varName"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure attempts to commit the staged package files to the<br> remote package file repository using Fossil. The varName argument<br> is the name of a scalar variable in the context of the immediate<br> caller that will receive the resulting Fossil check-in identifier.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle&ln=1370">::PackageUploader::textBoxEventHandler</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Required argument "varName"</span></big><br> <big><span style="font-family: monospace;"> Required argument "sender"</span></big><br> <big><span style="font-family: monospace;"> Required argument "e"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure is an event handler. It handles the Changed event<br> for a text box. It is not used when the user interface was built<br> with Tk. The varName argument is the name of the scalar variable<br> that must be updated with the contents of the text box. The sender<br> and e arguments are provided by the framework and represent the<br> control involved in the event and any extra data that may be<br> necessary to process the event.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle&ln=1384">::PackageUploader::listBoxEventHandler</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Required argument "varName"</span></big><br> <big><span style="font-family: monospace;"> Optional argument list "args"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure is an event handler. It handles double-clicking the<br> list box in both Tk and Eagle. The varName argument is the name of<br> the scalar variable that must be updated with the list of items from<br> the list box -OR- the list of items from an interactive file picker<br> dialog. The args argument, which is only used for Eagle, is a list<br> containing two elements. The first element is the control involved<br> in the event. The second element is any extra data that may be<br> necessary to process the event.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle&ln=1415">::PackageUploader::handleFormClosedEvent</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Optional argument list "args"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure is an event handler. It handles the Closed event for<br> a WinForms form -OR- the WM_DELETE_WINDOW event on a Tk window. The<br> args argument is not really used, it is a placeholder to make this<br> procedure more portable between Tcl and Eagle. This procedure may<br> raise script errors.<br> </blockquote><br><hr><br> <big><big><span style="font-family: monospace;">Private Procedure "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle&ln=1538">::PackageUploader::clearEventHandler</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgu.eagle">pkgu.eagle</a>")</span></big></big><br> <br> <big><span style="font-family: monospace;"> Optional argument list "args"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure is an event handler. It handles the clear button in<br> Tk and Eagle. It is used to clear the package submission data. The<br> args argument is not really used, it is a placeholder to make this<br> procedure more portable between Tcl and Eagle. This procedure may<br> raise script errors.<br> </blockquote><br><hr><br> </div> |
Modified doc/v1.html.asc from [a8e5ef3fb4] to [e3f0a78c63].
1 2 3 4 | -----BEGIN PGP SIGNATURE----- Version: GnuPG v2 Comment: Eagle Package Repository | | | | | | | | | | | | | | | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | -----BEGIN PGP SIGNATURE----- Version: GnuPG v2 Comment: Eagle Package Repository iQIcBAABCAAGBQJdwu/jAAoJEFAslq9JXcLZjZUQALbHoBLr356sM6h+gBnbg0vt ZDzoJXXNN1B5kB/lXMQF3E0UD3h698SXcpv9+G/j+e1Xrkie+iKFRKM2DSinmsO0 FG3Vdug5V8HHgYBUpdY6N255yZciQ2vU6kk3kNOnrdMqrNFz4Qmew4Udi9ooEu6D c+YqvHnq4bjU76PelhLFzsVxKZlwsz8FRmQMZudDh6gThS43YDyvBXvo8/s3dU5T CEPNNZxioOQaJUaeV/br4NwMoZLhJK0/qkLJfTtqiXeLO4+nObTW05ujJmt6Tjg4 aSv6nZQzYQOxJOfqkzd0gDU2wxaQbSQg1zUEZ+GApk2LCsG7Qdj0WCGvPgHAk6N2 UahSve5iIdLXTUe0yIU/s4xPTnwtj/MPzn0mmj4NpokSyOcheRvHQbOBnoyM8sZ1 K8bXXpNHmBM6E5D29x4dZ0+QXIhPERQtfJZLXVfivISUh/BlmY9qzzEyhxuLwROA qYNVaycO0Fd2LACMtXRMvdfe8zDOgBbHO7WPka1fNPY01cPVAjih2SmnVbCCSy0v u4kdJBSK5wsKb4zfuru/EhpIxNG29+/PxodAWWYJQbKZeS1OrKukbd7l9luOEarK issXMU7uMWjH4/jzGj4obPir/84NH75YuuN8OZONlIaaMyyk37aLjmVSbBBSDrIT zheb6fqVVO+xA8rNBCdU =h2Cf -----END PGP SIGNATURE----- |