Index: doc/v1.html ================================================================== --- doc/v1.html +++ doc/v1.html @@ -1,8 +1,8 @@

-Generated [2024-03-25 @ 03:39:49 UTC] from checkout [617a84df96503031e72bafc9255e9840485accd7 2024-03-22 04:56:26 UTC]


+Generated [2024-03-25 @ 04:59:00 UTC] from checkout [e110ec48d0eb7e2aebe1c4e8ffddd91317fbd1c0 2024-03-25 04:58:19 UTC]


Public API Procedure "::Eagle::Tools::Common::getFileViaHttp" (from "common.tcl")

@@ -824,11 +824,11 @@ not be raised by this procedure. The fileName argument must be
the fully qualified path and file name of the OpenPGP signature
file to verify.


-Public API Procedure "::PackageRepository::createOpenPgpSignature" (from "pkgr.eagle")
+Public API Procedure "::PackageRepository::createOpenPgpSignature" (from "pkgr.eagle")

    Required argument "fileName"

@@ -837,11 +837,11 @@ signature is created successfully. A script error should not be
raised by this procedure. The fileName argument must be the fully
qualified path and file name of the file to be signed.


-Public API Procedure "::PackageRepository::getUniqueSuffix" (from "pkgr.eagle")
+Public API Procedure "::PackageRepository::getUniqueSuffix" (from "pkgr.eagle")

    Optional argument "paranoia" with default value "1"

@@ -852,11 +852,11 @@ global namespace. The paranoia argument represents the relative
level of paranoia required by the caller; the higher this level,
the more uniqueness is required.


-Public API Procedure "::PackageRepository::useServerId" (from "pkgr.eagle")
+Public API Procedure "::PackageRepository::useServerId" (from "pkgr.eagle")

    Optional argument "serverId" with default value ""

@@ -865,11 +865,11 @@ backend repository servers may be used. The serverId argument
must consist only of alphanumeric characters and it must begin
with a letter.


-Public API Procedure "::PackageRepository::maybeReadSettingsFiles" (from "pkgr.eagle")
+Public API Procedure "::PackageRepository::maybeReadSettingsFiles" (from "pkgr.eagle")

    Required argument "script"

@@ -877,11 +877,11 @@ files, if they exists. Any script errors raised are not masked.
The script argument must be the fully qualified path and file name
for a package client toolset script file.


-Public API Procedure "::PackageRepository::getPackageFromRepository" (from "pkgr.eagle")
+Public API Procedure "::PackageRepository::getPackageFromRepository" (from "pkgr.eagle")

    Required argument "package"
    Required argument "version"
@@ -919,11 +919,11 @@ OpenPGP installation directory was successfully detected and added
to the PATH -OR- detecting and adding it was not necessary because
it already appeared to be available for use.


-Internal API Procedure "::PackageRepository::createHarpyCertificate" (from "pkgr.eagle")
+Internal API Procedure "::PackageRepository::createHarpyCertificate" (from "pkgr.eagle")

    Required argument "fileName"

@@ -934,11 +934,11 @@ fully qualified path and file name of the file to be signed. This
procedure assumes that the Harpy package for Eagle is installed and
ready for use (i.e. it can find a valid license certificate).


-Internal API Procedure "::PackageRepository::importOpenPgpKeyFile" (from "pkgr.eagle")
+Internal API Procedure "::PackageRepository::importOpenPgpKeyFile" (from "pkgr.eagle")

    Required argument "fileName"
    Required argument "varName"
@@ -952,11 +952,11 @@ to import. This procedure is only intended to be used from the
"pkgr_setup.eagle" tool script and may go away in later versions
of this package.


-Internal API Procedure "::PackageRepository::getApiKeys" (from "pkgr.eagle")
+Internal API Procedure "::PackageRepository::getApiKeys" (from "pkgr.eagle")

    Optional argument "prefix" with default value ""
    Optional argument "prefixOnly" with default value "false"
@@ -969,11 +969,11 @@ that are already configured. The prefixOnly argument should be
non-zero to exclude any API keys other than those based on the
prefix specified by the caller.


-Internal API Procedure "::PackageRepository::verifyMetadataLanguage" (from "pkgr.eagle")
+Internal API Procedure "::PackageRepository::verifyMetadataLanguage" (from "pkgr.eagle")

    Required argument "language"

@@ -980,11 +980,11 @@ This procedure verifies the language specified by the caller. The
language argument must be an empty string -OR- the literal string
"Eagle" or "Tcl". This procedure may raise script errors.


-Internal API Procedure "::PackageRepository::verifyServerId" (from "pkgr.eagle")
+Internal API Procedure "::PackageRepository::verifyServerId" (from "pkgr.eagle")

    Required argument "serverId"

@@ -991,19 +991,19 @@ This procedure verifies that the specified value is indeed a valid
server identifier. The serverId argument is the value to verify.
This procedure may raise script errors.


-Internal API Procedure "::PackageRepository::getSubmitBaseUri" (from "pkgr.eagle")
+Internal API Procedure "::PackageRepository::getSubmitBaseUri" (from "pkgr.eagle")

This procedure returns the base URI for the package repository
server endpoint that is used to submit packages. There are no
arguments.


-Internal API Procedure "::PackageRepository::getResponseCodeFromRawData" (from "pkgr.eagle")
+Internal API Procedure "::PackageRepository::getResponseCodeFromRawData" (from "pkgr.eagle")

    Required argument "data"

@@ -1010,11 +1010,11 @@ This procedure attempts to extract the lookup code from the raw
HTTP response data. The data argument is the raw HTTP response
data. An empty string is returned if no lookup code is available.


-Internal API Procedure "::PackageRepository::getResponseResultFromRawData" (from "pkgr.eagle")
+Internal API Procedure "::PackageRepository::getResponseResultFromRawData" (from "pkgr.eagle")

    Required argument "data"

@@ -1021,11 +1021,11 @@ This procedure attempts to extract the lookup result from the raw
HTTP response data. The data argument is the raw HTTP response
data. An empty string is returned if no lookup result is available.


-Internal API Procedure "::PackageRepository::isResponseCodeOk" (from "pkgr.eagle")
+Internal API Procedure "::PackageRepository::isResponseCodeOk" (from "pkgr.eagle")

    Required argument "code"

@@ -1032,27 +1032,27 @@ This procedure returns non-zero if the specified lookup response
code indicates success. The code argument is the extracted HTTP
lookup response code.


-Internal API Procedure "::PackageRepository::makeTclReady" (from "pkgr.eagle")
+Internal API Procedure "::PackageRepository::makeTclReady" (from "pkgr.eagle")

This procedure is designed for Eagle. It attempts to load the
"best" native Tcl library. It may raise any number of script
errors. There are no arguments.


-Internal API Procedure "::PackageRepository::eagleMustBeReady" (from "pkgr.eagle")
+Internal API Procedure "::PackageRepository::eagleMustBeReady" (from "pkgr.eagle")

This procedure, which may only be used from a native Tcl script,
checks if Garuda and Eagle are loaded and ready. If not, a script
error is raised. There are no arguments.


-Internal API Procedure "::PackageRepository::makeEagleReady" (from "pkgr.eagle")
+Internal API Procedure "::PackageRepository::makeEagleReady" (from "pkgr.eagle")

This procedure is designed for native Tcl. It attempts to load
the Garuda package and gain access to Eagle. It may raise any
number of script errors. There are no arguments.
@@ -1145,27 +1145,40 @@ This procedure returns the name of the file containing the OpenPGP
passphrase. This procedure is only used when creating an OpenPGP
signature. There are no arguments.


-Private Procedure "::PackageRepository::getLookupVarNamePrefix" (from "pkgr.eagle")
+Private Procedure "::PackageRepository::dequoteList" (from "pkgr.eagle")
+
+ +    Required argument "list"
+ +

+This procedure returns a list of the same size as the list argument
+value. Each element will have one pair of surrounding double quote
+characters removed -IF- they are the first and last non-whitespace
+character of that element. A script error should not be raised by
+this procedure.
+


+ +Private Procedure "::PackageRepository::getLookupVarNamePrefix" (from "pkgr.eagle")

This procedure returns the prefix for fully qualified variable
names that MAY be present in the global namespace. There are
no arguments.


-Private Procedure "::PackageRepository::getLookupBaseUri" (from "pkgr.eagle")
+Private Procedure "::PackageRepository::getLookupBaseUri" (from "pkgr.eagle")

This procedure returns the base URI for the package repository
server endpoint that is used to lookup packages. There are no
arguments.


-Private Procedure "::PackageRepository::getLookupUri" (from "pkgr.eagle")
+Private Procedure "::PackageRepository::getLookupUri" (from "pkgr.eagle")

    Required argument "apiKeys"
    Required argument "package"
@@ -1182,11 +1195,11 @@ looked up -OR- an empty string for any available version. There
are no HTTP requests issued by this procedure; it simply returns
the URI to use.


-Private Procedure "::PackageRepository::getIfNeededVersion" (from "pkgr.eagle")
+Private Procedure "::PackageRepository::getIfNeededVersion" (from "pkgr.eagle")

    Required argument "package"
    Required argument "version"
@@ -1198,11 +1211,11 @@ the name of the package, it cannot be an empty string. The
version argument is the specific version being looked up -OR- an
empty string for any available version.


-Private Procedure "::PackageRepository::packageRequirementToVersion" (from "pkgr.eagle")
+Private Procedure "::PackageRepository::packageRequirementToVersion" (from "pkgr.eagle")

    Required argument "requirement"

@@ -1211,11 +1224,11 @@ returned, if appropriate (i.e. any version should be allowed).
The requirement argument must be a package specification that
conforms to TIP #268.


-Private Procedure "::PackageRepository::getLookupData" (from "pkgr.eagle")
+Private Procedure "::PackageRepository::getLookupData" (from "pkgr.eagle")

    Required argument "apiKeys"
    Required argument "package"
@@ -1232,11 +1245,11 @@ empty string for any available version. This procedure may raise
script errors. All line-endings are normalized to Unix-style;
therefore, all script signatures must assume this.


-Private Procedure "::PackageRepository::isValidPackageName" (from "pkgr.eagle")
+Private Procedure "::PackageRepository::isValidPackageName" (from "pkgr.eagle")

    Required argument "name"
    Optional argument "emptyOk" with default value "false"
@@ -1246,11 +1259,11 @@ valid package name. The emptyOk argument can be non-zero if the
caller wishes to permit an empty string. This procedure is shared
with the server.


-Private Procedure "::PackageRepository::isValidPackageRequirement" (from "pkgr.eagle")
+Private Procedure "::PackageRepository::isValidPackageRequirement" (from "pkgr.eagle")

    Required argument "requirement"
    Required argument "rangeOk"
@@ -1269,11 +1282,11 @@ considered to be valid by the caller. The rangeOk argument should
be non-zero if the version range syntax is allowed; this argument is
ignored for Eagle because it requires TIP #268 support.


-Private Procedure "::PackageRepository::extractAndVerifyLookupMetadata" (from "pkgr.eagle")
+Private Procedure "::PackageRepository::extractAndVerifyLookupMetadata" (from "pkgr.eagle")

    Required argument "result"
    Required argument "varName"
@@ -1287,27 +1300,27 @@ of the immediate caller, that should receive the extracted package
lookup metadata. The caller argument must be an empty string -OR-
the literal string "handler".


-Private Procedure "::PackageRepository::tclMustBeReady" (from "pkgr.eagle")
+Private Procedure "::PackageRepository::tclMustBeReady" (from "pkgr.eagle")

This procedure, which may only be used from an Eagle script, checks
if a native Tcl library is loaded and ready. If not, a script error
is raised. There are no arguments.


-Private Procedure "::PackageRepository::eagleHasSecurity" (from "pkgr.eagle")
+Private Procedure "::PackageRepository::eagleHasSecurity" (from "pkgr.eagle")

This procedure returns non-zero if the current script is being
evaluated in Eagle with signed-only script security enabled.
There are no arguments.


-Private Procedure "::PackageRepository::processLookupMetadata" (from "pkgr.eagle")
+Private Procedure "::PackageRepository::processLookupMetadata" (from "pkgr.eagle")

    Required argument "varName"

@@ -1325,11 +1338,11 @@ is the name of an array variable in the call frame of the
immediate caller, that contains the package lookup metadata. This
procedure may raise script errors.


-Private Procedure "::PackageRepository::isPackagePresent" (from "pkgr.eagle")
+Private Procedure "::PackageRepository::isPackagePresent" (from "pkgr.eagle")

    Required argument "package"
    Required argument "version"
@@ -1340,11 +1353,11 @@ sought, it cannot be an empty string. The version argument must be
a specific version -OR- a package specification that conforms to TIP
#268.


-Private Procedure "::PackageRepository::isPackageAvailable" (from "pkgr.eagle")
+Private Procedure "::PackageRepository::isPackageAvailable" (from "pkgr.eagle")

    Required argument "package"
    Required argument "version"
@@ -1355,11 +1368,11 @@ sought, it cannot be an empty string. The version argument must be
a specific version -OR- a package specification that conforms to TIP
#268.


-Private Procedure "::PackageRepository::canDownloadPackage" (from "pkgr.eagle")
+Private Procedure "::PackageRepository::canDownloadPackage" (from "pkgr.eagle")

    Required argument "package"

@@ -1367,49 +1380,49 @@ downloaded, i.e. because it is not required for the downloading
process itself to be functional, etc. The package argument is
the name of the package to check.


-Private Procedure "::PackageRepository::setupPackageUnknownHandler" (from "pkgr.eagle")
+Private Procedure "::PackageRepository::setupPackageUnknownHandler" (from "pkgr.eagle")

This procedure performs initial setup of the package repository
client, using the current configuration parameters. There are
no arguments. It may load the Garuda package when evaluated in
native Tcl. It may load a native Tcl library when evaluated in
Eagle. It may install the [package unknown] hook.


-Private Procedure "::PackageRepository::isPackageUnknownHandlerHooked" (from "pkgr.eagle")
+Private Procedure "::PackageRepository::isPackageUnknownHandlerHooked" (from "pkgr.eagle")

This procedure returns non-zero if the [package unknown] handler
has already been hooked by the package repository client. There
are no arguments.


-Private Procedure "::PackageRepository::hookPackageUnknownHandler" (from "pkgr.eagle")
+Private Procedure "::PackageRepository::hookPackageUnknownHandler" (from "pkgr.eagle")

This procedure attempts to hook the [package unknown] handler. It
will raise a script error if this has already been done. The old
[package unknown] handler is saved and will be used by the new one
as part of the overall package loading process. There are no
arguments.


-Private Procedure "::PackageRepository::unhookPackageUnknownHandler" (from "pkgr.eagle")
+Private Procedure "::PackageRepository::unhookPackageUnknownHandler" (from "pkgr.eagle")

This procedure attempts to unhook the [package unknown] handler.
It will raise a script error if the [package unknown] handler is
not hooked. The old [package unknown] handler is restored and
the saved [package unknown] handler is cleared. There are no
arguments.


-Private Procedure "::PackageRepository::runSavedPackageUnknownHandler" (from "pkgr.eagle")
+Private Procedure "::PackageRepository::runSavedPackageUnknownHandler" (from "pkgr.eagle")

    Required argument "package"
    Required argument "version"
@@ -1418,11 +1431,11 @@ The procedure runs the saved [package unknown] handler. Any script
errors are raised to the caller. The package and version arguments
are passed in from the current [package unknown] handler verbatim.


-Private Procedure "::PackageRepository::packageUnknownHandler" (from "pkgr.eagle")
+Private Procedure "::PackageRepository::packageUnknownHandler" (from "pkgr.eagle")

    Required argument "package"
    Optional argument "version" with default value ""
@@ -1435,11 +1448,11 @@ that conforms to TIP #268. This version argument must be optional
here, because Eagle does not add a version argument when one is
not explicitly supplied to the [package require] sub-command.


-Private Procedure "::PackageRepository::getSettingsPrefixes" (from "pkgr.eagle")
+Private Procedure "::PackageRepository::getSettingsPrefixes" (from "pkgr.eagle")

    Required argument "scriptName"
    Required argument "envVarName"
@@ -1454,11 +1467,11 @@ evaluated, if any. The all parameter should be non-zero to include
all available prefixes, even if they are inapplicable to the current
configuration. This procedure may raise script errors.


-Private Procedure "::PackageRepository::maybeReadApiKeysFile" (from "pkgr.eagle")
+Private Procedure "::PackageRepository::maybeReadApiKeysFile" (from "pkgr.eagle")

This procedure evaluates a package repository client API keys
script file, if it has been configured -AND- actually exists.
Any script errors raised are not masked. The evaluated script
@@ -1465,11 +1478,11 @@ file should (normally) modify the "::pkgr_api_keys" variable
in order to add API keys for use with the package repository
client.


-Private Procedure "::PackageRepository::setupRepositoryOpenPgpVars" (from "pkgr.eagle")
+Private Procedure "::PackageRepository::setupRepositoryOpenPgpVars" (from "pkgr.eagle")

    Required argument "force"

@@ -1477,11 +1490,11 @@ parameters used to interact with the OpenPGP implementation.
If the force argument is non-zero, any existing values will be
overwritten and set back to their default values.


-Private Procedure "::PackageRepository::setupPackageUnknownVars" (from "pkgr.eagle")
+Private Procedure "::PackageRepository::setupPackageUnknownVars" (from "pkgr.eagle")

    Required argument "force"

Index: doc/v1.html.asc ================================================================== --- doc/v1.html.asc +++ doc/v1.html.asc @@ -1,18 +1,18 @@ -----BEGIN PGP SIGNATURE----- Version: GnuPG v2 Comment: Eagle Package Repository -iQIcBAABCAAGBQJmAPIjAAoJEFAslq9JXcLZhggQAKSadePmOnh12vbmcU3oukv9 -qfOmjO8qX+DCm4ByXxBVDhXJs0YIcheATPes15VY9kkGvgW8HNR8YkuoiokoDrYG -y+Vh9Rbm3pd6BW2EbdTDK83Da8CwCFIrC1uW/Sr/RXwc3LQ9H6t247laN4btslZC -ewrV/NkYla/jDHOTd8mqy8XwBnBTHtCZN5CkkixDDgjfKRSo4Zy/TtJw1xzD6fDo -KVCsklmY0c6E1Sqs4znnKR68W4ckmf2ZuRV3ywn9dLnzis/CJsDhsyHD3deKufeG -ZDlLvZ4mKCGT0ecgIGmSIkNDVKwEKtIdlfqdgTnYWh5SZv02IYkud5oe40N2dTEF -a0aur4sU2VEujyoPWIrPP1zIkAdtRAE6AK5TYokXQpb7VDfB1TYMsaJgmP4FSSLZ -SCajr5sikGgfnFBal+xhZGMubvtlpt8DfFQNqIVO0HTOxtOLGa6ESqpqQGSa36xM -k1YIwePYnGrMaenicZbwCPeA95nNyi47BYfCYCIjC5tyvcVPBVHjasQZAPHyjt9g -q5scv32af2+lCBdl90pzYT355oRnz3QeaQgwFE1FTze+Lgbp7rE+Fgdzf9sila1x -fAG7EIhA4fAFmgSYbMffkRBbkJTAH8i5Nz5PfVPpeR7JGSDsTPSD8BS+tm8fNh6p -OarlfJillorkT+vnn9Mp -=vUL8 +iQIcBAABCAAGBQJmAQS3AAoJEFAslq9JXcLZMfUQAL6qCJgbBRTuy3t62P4fWTxL +vVW7LGx8rw6TgocXFOh0Eq6v16E9I+37Ib7AdsPmmIm+vZZ+jxBsYQamsLxRvMNb +jqLezFBmai4g3cQ6JbefdgWlbEG11mK3KcjOKC0L+sYk5C3m6lGJugeaE+/zB2ox +dLXC/cT4ZW0i7MWkYvHsC0tJ9iLo5bJvzrSQ6/BL67eT+sD1ohVY9lNcL/0v06KQ +8yEEPGPE0NZZfOHuCnHzDMTjSzzAPItnPgq3SpHMGaQb3SmCDvXhw3TBRR8dqHCh +1nksYz4UrEKul/HM3AVJin8ULY8GUJRStLamtKV6myeSPh3pE24hmnijOV9zYfbl +FKfRWLaQY9Cv6PbrEBejSw6MHVC9Js7zwRdaxV/U+jSQtUygcoyx7sqKQQn2EMLU +aAFTgf4Q7NHagAPKphqKZrsdcbVvzEIfcM0yjDeGViMZicGHSTfh2RkV03mCEnBv +J8v4VqyDU34vUaSyIdFS5yxvhxxbkD3b4WpfiPL4WRGW/lguKIOamkxyyXLTjYs0 +Nvoq/V++mXs0cnr0gDWPVh3ujlAlWCDDoYS3XQ8KCLWh+e+vrGkSVHEkW9nW/j9g +mUJYJ0lBYEbvuiAAN3LTPmN3ZkkScnTeTBpKUJFbjt5keBJWrQ0TvxOk0AbgxBb1 +l7Ubhp7gnDzpP/G0vrwS +=eNvr -----END PGP SIGNATURE-----