summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPatrick McDermott <patrick.mcdermott@libiquity.com>2019-03-14 00:25:27 (EDT)
committer Patrick McDermott <patrick.mcdermott@libiquity.com>2019-03-14 00:26:34 (EDT)
commit01ae34db9f4d4e0e6e94c9537c9ba618599473ee (patch)
tree1ba03b97d6a1e0844f1e6bcf0f3c8032a82704eb
parent2a9373211308ecf0b44d5bb11650948d2b817e6d (diff)
ob_init_package(): Document
-rw-r--r--lib/package.sh9
1 files changed, 9 insertions, 0 deletions
diff --git a/lib/package.sh b/lib/package.sh
index 5c78b01..85cbd98 100644
--- a/lib/package.sh
+++ b/lib/package.sh
@@ -33,6 +33,15 @@ _ob_package_do()
return 0
}
+## @brief Initialize libopkbuild for a source package
+## @details \fBob_init_package\fP detects the version of and parses all metadata
+## of a source package. This function must be called before any other
+## functions that operate on package metadata.
+## @operand dir req The root directory of the source package.
+## @return Returns 0 on success or 1 if the source package version can't be
+## detected or if the metadata can't be parsed.
+## @stderr Prints error or warning messages on detection or parsing errors.
+## @pure no This function sets internal global variables.
ob_init_package()
{
local dir="${1}"