summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPatrick McDermott <patrick.mcdermott@libiquity.com>2019-03-14 01:01:37 (EDT)
committer Patrick McDermott <patrick.mcdermott@libiquity.com>2019-03-14 01:02:41 (EDT)
commite3153cd84876a6c42f127329a6366059a3f6e1b4 (patch)
tree717fc015f5bdfa0efa6bca03319279a24dd14c96
parentfc98ade63b5218b699975aca8511e97e27eb03eb (diff)
ob_get_binary_packages(): Document
-rw-r--r--lib/package.sh14
1 files changed, 14 insertions, 0 deletions
diff --git a/lib/package.sh b/lib/package.sh
index c499378..fca1894 100644
--- a/lib/package.sh
+++ b/lib/package.sh
@@ -69,6 +69,20 @@ ob_init_package()
return 0
}
+## @brief Get a list of binary packages
+## @details \fBob_get_binary_packages\fP finds a source package's binary
+## packages, optionally filtering for packages that build for a certain
+## host architecture and/or platform.
+## @option -a host_arch The architecture by which to filter binary packages.
+## @option -a host_plat The platform by which to filter binary packages.
+## @return Returns 0 on success.
+## @stdout Prints the resulting list of binary packages.
+## @stderr Prints warning messages on invalid binary package names and duplicate
+## "clean" binary package names.
+## @pure maybe This function caches a list of all binary packages to an internal
+## global variable to save time and avoid repeating warning messages
+## on subsequent invocations. It should therefore first be called
+## outside a subshell, though this is not required.
ob_get_binary_packages()
{
local opt=