Overview
| Comment: | Update generated documentation. |
|---|---|
| Downloads: | Tarball | ZIP archive | SQL archive |
| Timelines: | family | ancestors | descendants | both | trunk |
| Files: | files | file ages | folders |
| SHA1: |
617a84df96503031e72bafc9255e9840 |
| User & Date: | mistachkin on 2024-03-22 04:56:26 |
| Other Links: | manifest | tags |
Context
|
2024-03-25
| ||
| 03:40 | Fix a comment. check-in: 52f4d4c21f user: mistachkin tags: trunk | |
|
2024-03-22
| ||
| 04:56 | Update generated documentation. check-in: 617a84df96 user: mistachkin tags: trunk | |
|
2024-03-16
| ||
| 05:44 | Make sure that the '-timeouttype' option is used everywhere appropriate. check-in: 18576af26f user: mistachkin tags: trunk | |
Changes
Modified doc/v1.html from [5cff4ba5c2] to [99042692d3].
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;">Generated [2024-03-22 @ 04:55:13 UTC] from checkout [18576af26f2b8bc38fb1a5c77cf76a99256a5e6e 2024-03-16 05:44:00 UTC]</span></big></big><br><br><hr><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=272">::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> |
| ︙ | ︙ | |||
126 127 128 129 130 131 132 | <blockquote style="font-family: monospace;"><br> This procedure modifies the version variables used by the package<br> downloader client so that a specific version will be used. The<br> versionId argument must consist only of hexadecimal characters.<br> </blockquote><br><hr><br> | | | | | | 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 | <blockquote style="font-family: monospace;"><br> This procedure modifies the version variables used by the package<br> downloader client so that a specific version will be used. The<br> versionId argument must consist only of hexadecimal characters.<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/pkgd.eagle&ln=1386">::PackageDownloader::resetCookieAndLoginSimple</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>")</span></big></big><br> <blockquote style="font-family: monospace;"><br> This procedure resets the currently configured login cookie, if<br> any, and then attempts to login using the configured package<br> repository server API key -OR- using the public access account.<br> Upon success, it will set the login cookie to the one from the<br> raw response data. Upon failure, a script error will be raised.<br> There are no arguments.<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/pkgd.eagle&ln=1436">::PackageDownloader::resetCookieAndLogin</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 "userName"</span></big><br> <big><span style="font-family: monospace;"> Required argument "password"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure resets the currently configured login cookie, if<br> any, and then attempts to login using the specified user name and<br> password. Upon success, it will set the login cookie to the one<br> from the raw response data. Upon failure, a script error will be<br> raised. The userName argument must be the name of a package file<br> server user with at least Fossil Check-Out (o) permissions on the<br> package file server. The password argument must be the plaintext<br> password that is associated with the specified user name.<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/pkgd.eagle&ln=1489">::PackageDownloader::logoutAndResetCookie</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>")</span></big></big><br> <blockquote style="font-family: monospace;"><br> This procedure attempts to logout using the currently configured<br> login cookie, if any, and then resets the login cookie. There<br> are no arguments. This procedure may raise a script error.<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/pkgd.eagle&ln=1722">::PackageDownloader::checkForHigherVersion</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 "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> |
| ︙ | ︙ | |||
193 194 195 196 197 198 199 | not require a specific platform. The packageName argument is a<br> directory name relative to the language and version-specific<br> directory on the package file server and may be an empty string.<br> The usePgp argument should be non-zero when an OpenPGP signature<br> file needs to be downloaded and verified for the downloaded file.<br> </blockquote><br><hr><br> | | | 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 | not require a specific platform. The packageName argument is a<br> directory name relative to the language and version-specific<br> directory on the package file server and may be an empty string.<br> The usePgp argument should be non-zero when an OpenPGP signature<br> file needs to be downloaded and verified for the downloaded 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/pkgd.eagle&ln=2030">::PackageDownloader::downloadFiles</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 "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> |
| ︙ | ︙ | |||
231 232 233 234 235 236 237 | for each downloaded file. The -useAutoPath option should be<br> non-zero to modify the auto-path to include the temporary or<br> persistent directories containing the downloaded files. The<br> -allowUpdate option should be non-zero to allow existing package<br> files to be overwritten.<br> </blockquote><br><hr><br> | | | 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 | for each downloaded file. The -useAutoPath option should be<br> non-zero to modify the auto-path to include the temporary or<br> persistent directories containing the downloaded files. The<br> -allowUpdate option should be non-zero to allow existing package<br> files to be overwritten.<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/pkgd.eagle&ln=2256">::PackageDownloader::maybeAddTemporaryPackagesToAutoPath</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 "language"</span></big><br> <big><span style="font-family: monospace;"> Required argument "options"</span></big><br> <big><span style="font-family: monospace;"> Optional argument "pattern" with default value ""</span></big><br> |
| ︙ | ︙ | |||
357 358 359 360 361 362 363 | entity does not require a specific platform. The varName argument<br> is the name of a variable in the context of the immediate caller<br> that will receive a modified platform name, if applicable. Upon<br> failure, a script error will be raised. The return value is<br> undefined.<br> </blockquote><br><hr><br> | | | 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 | entity does not require a specific platform. The varName argument<br> is the name of a variable in the context of the immediate caller<br> that will receive a modified platform name, if applicable. Upon<br> failure, a script error will be raised. The return value is<br> undefined.<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/pkgd.eagle&ln=1413">::PackageDownloader::maybeResetCookieAndLoginSimple</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>")</span></big></big><br> <blockquote style="font-family: monospace;"><br> This procedure attempts to login using the configured package<br> repository server API key -OR- using the public access account,<br> if not already logged in. Upon success, it will set the login<br> cookie to the one from the raw response data. Upon failure, a<br> script error will be raised. There are no arguments.<br> |
| ︙ | ︙ | |||
600 601 602 603 604 605 606 | will always use the currently configured HTTP(S) login cookie, if<br> any; therefore, it should really only be used for requests to the<br> package file server. The uri argument is the fully qualified URI<br> to request. The allowHtml argument should be non-zero if raw HTML<br> should be allowed in the response data.<br> </blockquote><br><hr><br> | | | | | | | | | 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 | will always use the currently configured HTTP(S) login cookie, if<br> any; therefore, it should really only be used for requests to the<br> package file server. The uri argument is the fully qualified URI<br> to request. The allowHtml argument should be non-zero if raw HTML<br> should be allowed in the response data.<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=1373">::PackageDownloader::getDownloadVarNamePrefix</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgd.eagle">pkgd.eagle</a>")</span></big></big><br> <blockquote style="font-family: monospace;"><br> This procedure returns the prefix for fully qualified variable<br> names that MAY be present in the global namespace. There are<br> 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/pkgd.eagle&ln=1543">::PackageDownloader::getUniqueTempDirectory</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;"> Optional argument "prefix" with default value ""</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure returns a unique temporary directory where one or<br> more files may be saved. The prefix argument is a prefix for the<br> directory name and it may be an empty string. There is no attempt<br> to actually create the resulting directory.<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=1573">::PackageDownloader::createInterp</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 "varName"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure creates a new interpreter, which may be "safe", and<br> places a reference to it in a variable in the context of the caller<br> identified by the varName argument. The created interpreter has a<br> fully functioning [package] command ensemble; all other commands do<br> nothing and return nothing. 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/pkgd.eagle&ln=1650">::PackageDownloader::getIfNeededVersions</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 "interp"</span></big><br> <big><span style="font-family: monospace;"> Required argument "fileName"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure evaluates a script file and attempts to determine the<br> list of new [package ifneeded] scripts added by it. When successful<br> it returns a list-of-lists. Each element of the outer list contains<br> a package name and the list of its versions in descending order; in<br> the event of failure, empty lists may be returned for the outer list<br> or for a list of versions. The interp argument is the interp to use<br> when evaluating the file specified by the fileName argument. This<br> 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/pkgd.eagle&ln=1673">::PackageDownloader::extractVersionsFromFile</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 "fileName"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure attempts to extract a package version information<br> from the specified file. The fileName argument is the local file<br> name to read. 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/pkgd.eagle&ln=1785">::PackageDownloader::guessPackageNameFromFileNames</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 "language"</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 guess a package name based on a list of<br> its files. It relies upon the fact that all packages must include<br> a package index file. The language argument must be one of the<br> literal strings "eagle", "tcl", or "client". The fileNames argument<br> must be the list of file names to be downloaded. The package name,<br> if one can be detected, is returned; otherwise, an empty string will<br> be 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/pkgd.eagle&ln=1819">::PackageDownloader::downloadAllPlatforms</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 "language"</span></big><br> <big><span style="font-family: monospace;"> Required argument "version"</span></big><br> <big><span style="font-family: monospace;"> Required argument "packageName"</span></big><br> |
| ︙ | ︙ | |||
707 708 709 710 711 712 713 | is a directory name relative to the language and version-specific<br> directory on the package file server and may be an empty string.<br> The fileNames argument is the list of file names to be downloaded.<br> The usePgp argument should be non-zero when an OpenPGP signature<br> needs to be verified for the downloaded file.<br> </blockquote><br><hr><br> | | | | 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 | is a directory name relative to the language and version-specific<br> directory on the package file server and may be an empty string.<br> The fileNames argument is the list of file names to be downloaded.<br> The usePgp argument should be non-zero when an OpenPGP signature<br> needs to be verified for the downloaded file.<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=1923">::PackageDownloader::downloadOneUriToFile</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 "localFileName"</span></big><br> <big><span style="font-family: monospace;"> Required argument "uri"</span></big><br> <big><span style="font-family: monospace;"> Required argument "usePgp"</span></big><br> <big><span style="font-family: monospace;"> Required argument "forcePgp"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure downloads a single URI from the package file server<br> and writes the result to a local file. The localFileName argument<br> is the file name where the downloaded file should be written. The<br> The uri argument is the URI to download. The usePgp argument should<br> be non-zero when the OpenPGP signature file needs to be verified for<br> the downloaded file. 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/pkgd.eagle&ln=1964">::PackageDownloader::downloadOneFile</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 "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> |
| ︙ | ︙ |
Modified doc/v1.html.asc from [7b4a9c704c] to [9a42983589].
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 iQIcBAABCAAGBQJl/Q92AAoJEFAslq9JXcLZ3soP/3NKT5+5XpO4+yfkfygCIDXn bMUelRGjHywwfgni3BHdMqcAMhE/N7qXci76UYXhOmQ8/KIrCeoLDRL+iuTKNP/d onVoW4uBGU6VSg2FvqIny8cN93u0lFKpY793zH8GdUl50VfFyJUrrmIe+I6GC0A/ AKHWqPQsCvOKZJ6s7b/fLvwLyxulMRhhGjFKRWmpjSayDsXHVWKGEqE9bQYvcbaF dmWr2Pj2UYeFumobr0g/CtSzemQ/vpdZRW3lbzvF0QH8GcB4kgHkA9SZNUH/rTO6 R6/U+yUJxK5TFJTLIXw0YpT6/slZFj1fZ4+kI24L/NhPvOM4kdpU4h8On1T1IaaH 8YGCuKjuU1txoLboCAA2/bFaHn3O6LKQkpnc34dNBQTb/Q+lABWBTc6UCPiDKfrj acSlNZxSU9gHvgvTBalyNG6a3BoE52iLKYhSjvtvEpek8eec7uxEfmdyMKmDlNbb q966P7lHhn26ECCEOnhqIcJrQS/rEQYy7Ih9tuYzFzDwEEL0dDSFr859BS3oi2q/ A21q9HGde7sZZvJbvl3Ox42KWd1++S/xo8e2fCIj577hEaLSUQfkMM0JtKrMfsWr hbBCAjKQHBDUs81cx5QSYg0jdAU0/4edjOPoqAE2Rmd5157BLrD4dmWY6HZYx+bU 4F1mltYxzp98LB8TOOI1 =GStb -----END PGP SIGNATURE----- |