Overview
| Comment: | Update docs. |
|---|---|
| Downloads: | Tarball | ZIP archive | SQL archive |
| Timelines: | family | ancestors | descendants | both | trunk |
| Files: | files | file ages | folders |
| SHA1: |
898d013d38c33735d5a513c885a658cc |
| User & Date: | mistachkin on 2019-09-08 22:06:55 |
| Other Links: | manifest | tags |
Context
|
2019-09-08
| ||
| 23:33 | Add uploader files to the deployment tool. check-in: aeb9a220c0 user: mistachkin tags: trunk | |
| 22:06 | Update docs. check-in: 898d013d38 user: mistachkin tags: trunk | |
| 21:56 | Stub in support for grabbing the package name out of the lookup metadata. check-in: ccfa024e3e user: mistachkin tags: trunk | |
Changes
Modified doc/v1.html from [a53e28c193] to [10103d412d].
| ︙ | ︙ | |||
737 738 739 740 741 742 743 | This procedure modifies the URN variables used by the package<br> repository client so that one or more alternative (private?)<br> backend repository servers may be used. The serverId argument<br> must consist only of alphanumeric characters and it must begin<br> with a letter.<br> </blockquote><br><hr><br> | | | | 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 | This procedure modifies the URN variables used by the package<br> repository client so that one or more alternative (private?)<br> backend repository servers may be used. The serverId argument<br> must consist only of alphanumeric characters and it must begin<br> with a letter.<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=2199">::PackageRepository::maybeReadSettingsFile</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 "script"</span></big><br> <blockquote style="font-family: monospace;"><br> 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=2509">::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> |
| ︙ | ︙ | |||
905 906 907 908 909 910 911 | <blockquote style="font-family: monospace;"><br> This procedure returns non-zero if the specified lookup response<br> code indicates success. The code argument is the extracted HTTP<br> lookup response code.<br> </blockquote><br><hr><br> | | | | | 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 | <blockquote style="font-family: monospace;"><br> This procedure returns non-zero if the specified lookup response<br> code indicates success. The code argument is the extracted HTTP<br> lookup response code.<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/pkgr.eagle&ln=1370">::PackageRepository::makeTclReady</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>")</span></big></big><br> <blockquote style="font-family: monospace;"><br> This procedure is designed for Eagle. It attempts to load the<br> "best" native Tcl library. It may raise any number of script<br> errors. 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/pkgr.eagle&ln=1399">::PackageRepository::eagleMustBeReady</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>")</span></big></big><br> <blockquote style="font-family: monospace;"><br> This procedure, which may only be used from a native Tcl script,<br> checks if Garuda and Eagle are loaded and ready. If not, a script<br> error is raised. 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/pkgr.eagle&ln=1423">::PackageRepository::makeEagleReady</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>")</span></big></big><br> <blockquote style="font-family: monospace;"><br> This procedure is designed for native Tcl. It attempts to load<br> the Garuda package and gain access to Eagle. It may raise any<br> number of script errors. There are no arguments.<br> </blockquote><br><hr><br> |
| ︙ | ︙ | |||
1105 1106 1107 1108 1109 1110 1111 | is the name of the package, it cannot be an empty string. The<br> version argument is the specific version being looked up -OR- an<br> empty string for any available version. This procedure may raise<br> script errors. All line-endings are normalized to Unix-style;<br> therefore, all script signatures must assume this.<br> </blockquote><br><hr><br> | | > > > > > > > > > > > > > > | 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 | is the name of the package, it cannot be an empty string. The<br> version argument is the specific version being looked up -OR- an<br> empty string for any available version. This procedure may raise<br> script errors. All line-endings are normalized to Unix-style;<br> therefore, all script signatures must assume this.<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=1162">::PackageRepository::isValidPackageName</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 "name"</span></big><br> <big><span style="font-family: monospace;"> Optional argument "emptyOk" with default value "false"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure returns non-zero if the specified string value is a<br> valid package name. The emptyOk argument can be non-zero if the<br> caller wishes to permit an empty string. This procedure is shared<br> with the server.<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=1183">::PackageRepository::isValidPackageRequirement</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 "requirement"</span></big><br> <big><span style="font-family: monospace;"> Required argument "rangeOk"</span></big><br> <big><span style="font-family: monospace;"> Optional argument "emptyOk" with default value "false"</span></big><br> |
| ︙ | ︙ | |||
1128 1129 1130 1131 1132 1133 1134 | package version, with up to four components, without any 'a' or 'b'.<br> The emptyOk argument should be non-zero if an empty string should be<br> considered to be valid by the caller. The rangeOk argument should<br> be non-zero if the version range syntax is allowed; this argument is<br> ignored for Eagle because it requires TIP #268 support.<br> </blockquote><br><hr><br> | | | | | | 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 | package version, with up to four components, without any 'a' or 'b'.<br> The emptyOk argument should be non-zero if an empty string should be<br> considered to be valid by the caller. The rangeOk argument should<br> be non-zero if the version range syntax is allowed; this argument is<br> ignored for Eagle because it requires TIP #268 support.<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=1241">::PackageRepository::extractAndVerifyLookupMetadata</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 "result"</span></big><br> <big><span style="font-family: monospace;"> Required argument "varName"</span></big><br> <big><span style="font-family: monospace;"> Required argument "caller"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure attempts to extract the package lookup metadata from<br> the lookup result. The result argument is the lookup result. The<br> varName argument is the name of an array variable, in the call frame<br> of the immediate caller, that should receive the extracted package<br> lookup metadata. The caller argument must be an empty string -OR-<br> the literal string "handler".<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=1346">::PackageRepository::tclMustBeReady</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>")</span></big></big><br> <blockquote style="font-family: monospace;"><br> This procedure, which may only be used from an Eagle script, checks<br> if a native Tcl library is loaded and ready. If not, a script error<br> is raised. 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/pkgr.eagle&ln=1450">::PackageRepository::eagleHasSecurity</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>")</span></big></big><br> <blockquote style="font-family: monospace;"><br> This procedure returns non-zero if the current script is being<br> evaluated in Eagle with signed-only script security enabled.<br> 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/pkgr.eagle&ln=1482">::PackageRepository::processLookupMetadata</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 "varName"</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure uses the package lookup metadata. If the package<br> script is properly signed, an attempt will be made to evaluate it<br> |
| ︙ | ︙ | |||
1184 1185 1186 1187 1188 1189 1190 | script itself to either add the package or provide the package to<br> the language(s) supported by that package. The varName argument<br> is the name of an array variable in the call frame of the<br> immediate caller, that contains the package lookup metadata. This<br> procedure may raise script errors.<br> </blockquote><br><hr><br> | | | | | | | | | | | | | | 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 | script itself to either add the package or provide the package to<br> the language(s) supported by that package. The varName argument<br> is the name of an array variable in the call frame of the<br> immediate caller, that contains the package lookup metadata. 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/pkgr.eagle&ln=1853">::PackageRepository::isPackagePresent</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> <blockquote style="font-family: monospace;"><br> This procedure returns non-zero if the specified package appears to<br> be present. The package argument is the name of the package being<br> sought, it cannot be an empty string. The version argument must be<br> a specific version -OR- a package specification that conforms to TIP<br> #268.<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=1885">::PackageRepository::isPackageAvailable</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> <blockquote style="font-family: monospace;"><br> This procedure returns non-zero if the specified package appears to<br> be available. The package argument is the name of the package being<br> sought, it cannot be an empty string. The version argument must be<br> a specific version -OR- a package specification that conforms to TIP<br> #268.<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=1938">::PackageRepository::canDownloadPackage</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> <blockquote style="font-family: monospace;"><br> This procedure returns non-zero if the specified package can be<br> downloaded, i.e. because it is not required for the downloading<br> process itself to be functional, etc. The package argument is<br> the name of the package to check.<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=1984">::PackageRepository::setupPackageUnknownHandler</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>")</span></big></big><br> <blockquote style="font-family: monospace;"><br> This procedure performs initial setup of the package repository<br> client, using the current configuration parameters. There are<br> no arguments. It may load the Garuda package when evaluated in<br> native Tcl. It may load a native Tcl library when evaluated in<br> Eagle. It may install the [package unknown] hook.<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=2024">::PackageRepository::isPackageUnknownHandlerHooked</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>")</span></big></big><br> <blockquote style="font-family: monospace;"><br> This procedure returns non-zero if the [package unknown] handler<br> has already been hooked by the package repository client. There<br> 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/pkgr.eagle&ln=2036">::PackageRepository::hookPackageUnknownHandler</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>")</span></big></big><br> <blockquote style="font-family: monospace;"><br> This procedure attempts to hook the [package unknown] handler. It<br> will raise a script error if this has already been done. The old<br> [package unknown] handler is saved and will be used by the new one<br> as part of the overall package loading process. There are no<br> 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/pkgr.eagle&ln=2054">::PackageRepository::unhookPackageUnknownHandler</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>")</span></big></big><br> <blockquote style="font-family: monospace;"><br> This procedure attempts to unhook the [package unknown] handler.<br> It will raise a script error if the [package unknown] handler is<br> not hooked. The old [package unknown] handler is restored and<br> the saved [package unknown] handler is cleared. There are no<br> 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/pkgr.eagle&ln=2070">::PackageRepository::runSavedPackageUnknownHandler</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> <blockquote style="font-family: monospace;"><br> The procedure runs the saved [package unknown] handler. Any script<br> errors are raised to the caller. The package and version arguments<br> are passed in from the current [package unknown] handler verbatim.<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=2092">::PackageRepository::packageUnknownHandler</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;"> Optional argument "version" with default value ""</span></big><br> <blockquote style="font-family: monospace;"><br> This procedure is the [package unknown] handler entry point called<br> by native Tcl and Eagle. The package argument is the name of the<br> package being sought, it cannot be an empty string. The version<br> argument must be a specific version -OR- a package specification<br> that conforms to TIP #268. This version argument must be optional<br> here, because Eagle does not add a version argument when one is<br> not explicitly supplied to the [package require] sub-command.<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=2256">::PackageRepository::maybeReadApiKeysFile</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>")</span></big></big><br> <blockquote style="font-family: monospace;"><br> This procedure evaluates a package repository client API keys<br> 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=2277">::PackageRepository::setupRepositoryOpenPgpVars</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>")</span></big></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> 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/pkgr.eagle&ln=2396">::PackageRepository::setupPackageUnknownVars</a>" (from "<a href="$ROOT/artifact?ci=trunk&filename=client/1.0/neutral/pkgr.eagle">pkgr.eagle</a>")</span></big></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. There are no<br> arguments.<br> </blockquote><br><hr><br> |
| ︙ | ︙ |
Modified doc/v1.html.asc from [fcf807d82c] to [89033638d6].
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 iQIcBAABCAAGBQJddXtqAAoJEFAslq9JXcLZKCUQAIs4CiGExGghiYq8PK3HyMJe qkI1yqtPstUgSltlSzqbgYdQY3nayDxwUp6+RTdXAW/lIWMuFBG0yydmyAa3Ux2d HSR+8YFdIRRjJK7JgO3vFA2yj925KDlet4j2kLTQPhmx3jruOm9K03S/SMy1Nv4P vU9If18R1WHPYeZuOEFx6kyQAwaIhOqUwcvxzSQhQ1XaP8P89tvCqs6GFm4mrevX GcnB8qAXgd2jVwI8uCzs1XFn/4xF54srqI7DBSgZr5gqMMJBqFDVwQGkWmKfP5FR ITwo1KTjGIPXH1RVUoSWFz0P2TMXg8iCBY4yl5mJr1eopy2RRULRnY+a/vAQXRCK aOqweSdU3qOZJ0s5jeoBhV4A9ty24EMeMUwN+/HyUzHFOYblbUGUtLWKrXJomRiD w4U1Yl7brDsk4JWmgpyOuQ78VSS03tlYpQeT1t6gJZw457V8tlnyApsJs6/2EjVs IIxZeVz/f9BhtluCv1CU/3D/jkIkoihqPbZOqGWB6XvFq+iOEVvmGm06djtJ0Xpp pW41a79JPewJzo84IxZvyu6oOMn1szwszbod42cHb9Av18nYT9jDmNU0oS+KGAhk 7dDJ2v3/Tr6NMPrbKOI/tQ/sMvVWxOgYfdyxn8r0Dq/pitnINWAagv6QzI1Be37n eHZmD4zKSoKJ/t7Q922m =Kqw1 -----END PGP SIGNATURE----- |