summaryrefslogtreecommitdiffstats
path: root/lib
diff options
context:
space:
mode:
authorPatrick McDermott <patrick.mcdermott@libiquity.com>2018-12-29 13:29:19 (EST)
committer Patrick McDermott <patrick.mcdermott@libiquity.com>2018-12-29 13:29:19 (EST)
commitd814da6fb0a3cc4091cffc54aad70dfc04628cac (patch)
tree5e97deadbf9ec1847b380c9a429a7a65f324abac /lib
parent5853f246ad786bea22706abb9a2b9d06357ebe26 (diff)
ob_get_system_path(): Document
Diffstat (limited to 'lib')
-rw-r--r--lib/metadata.sh15
1 files changed, 15 insertions, 0 deletions
diff --git a/lib/metadata.sh b/lib/metadata.sh
index fd64a13..5628a18 100644
--- a/lib/metadata.sh
+++ b/lib/metadata.sh
@@ -329,6 +329,21 @@ ob_plat_is_concerned()
fi
}
+## @brief Get a system path
+## @details \fBob_get_system_path\fP gets a system path consisting of \fIargs\fP
+## formatted, by the metadata plugin selected at libopkbuild's build
+## time, according to a path format identified by \fIpath_id\fP. The
+## arguments for a \fIpath_id\fP of either \fBpackage-source\fP or
+## \fBpackage-docs\fP are \fIsource\fP and \fIversion\fP. For
+## \fBbuildflags\fP the argument is \fI arch\fP. For \fBplatconf\fP
+## they are \fIsource\fP, \fIversion\fP, and \fIplat\fP.
+## @operand path_id req One of \fBpackage-source\fP, \fBpackage-docs\fP,
+## \fBbuildflags\fP, or \fBplatconf\fP.
+## @operand args req Additional arguments specific to each \fIpath_id\fP.
+## @return Returns 0 on success, or 125 if given an incorrect number of
+## arguments.
+## @stdout Prints the requested path with \fIargs\fP.
+## @pure yes This function has no side effects.
ob_get_system_path()
{
local path_id=