summaryrefslogtreecommitdiffstats
path: root/lib
diff options
context:
space:
mode:
authorPatrick McDermott <patrick.mcdermott@libiquity.com>2018-12-27 02:25:04 (EST)
committer Patrick McDermott <patrick.mcdermott@libiquity.com>2018-12-27 02:25:04 (EST)
commitac57efad422af8f82066b1609b0f29ec9e31e205 (patch)
treef5a093c70ec6119d321faacbe65abdc93173f939 /lib
parentb1e14cfe7b10188e4bb04dffe2e465cc0c73b6ca (diff)
ob_parse_dep(): Clarify optional components in doc
Diffstat (limited to 'lib')
-rw-r--r--lib/deps.sh5
1 files changed, 3 insertions, 2 deletions
diff --git a/lib/deps.sh b/lib/deps.sh
index 8ba919d..39f6506 100644
--- a/lib/deps.sh
+++ b/lib/deps.sh
@@ -38,8 +38,9 @@
## the given platform.
## @operand dep req The dependency to parse.
## @details \fBob_parse_dep\fP() parses package dependencies in the format
-## \fIpkg:archqual (rel ver) [arches] <plats>\fP, where all components
-## are optional except \fIpkg\fP.
+## \fIpkg:archqual (rel ver) [arches] <plats>\fP, where the components
+## \fI:archqual\fP, \fI(rel ver)\fP, \fI[arches]\fP, and \fI<plats>\fP
+## are optional.
## @return Returns 0.
## @stdout Prints the dependency, with normalized formatting, if the dependency
## applies to the given host architecture and platform if any.