From cfd513503ccb8d4fc8013dade2f8d059c561fac0 Mon Sep 17 00:00:00 2001 From: Patrick McDermott Date: Fri, 28 Dec 2018 18:49:44 -0500 Subject: ob_parse_dep(): Improve documentation --- (limited to 'lib') diff --git a/lib/deps.sh b/lib/deps.sh index 3ae37d8..7a63a31 100644 --- a/lib/deps.sh +++ b/lib/deps.sh @@ -31,9 +31,9 @@ ## @option -v ver_var The name of the variable in which to store the ## version, if any. ## @option -A arches_var The name of the variable in which to store the -## architectures, if any. +## architecture restrictions, if any. ## @option -l plats_var The name of the variable in which to store the -## platforms, if any. +## platform restrictions, if any. ## @option -a host_arch The host architecture. If given, the dependency will ## only be printed on standard output if it applies to ## the given architecture. @@ -42,10 +42,15 @@ ## the given platform. ## @operand dep req The dependency to parse. ## @return Returns 0. -## @stdout Prints the dependency, with normalized formatting, if the dependency -## applies to the given host architecture and platform if any. +## @stdout If \fB-a\fP and \fB\P\fP aren't given, the entire dependency string +## is printed, with normalized formatting. If \fB-a\fP and/or \fB-P\fP +## are given and the dependency applies to their arguments, the +## dependency string is printed, except for the architecture (if +## \fB-a\fP given) and/or platform (if \fB-P\fP given) restrictions, +## with normalized formatting. Normalized formatting is a string of the +## format \fIpkg:archqual\ (rel\ ver)\ [arches]\ \fP. ## @pure maybe This function has side effects when used with any of the options -## \fI-p\fP, \fI-q\fP, \fI-r\fP, \fI-v\fP, \fI-A\fP, or \fI-l\fP. +## \fB-p\fP, \fB-q\fP, \fB-r\fP, \fB-v\fP, \fB-A\fP, or \fB-l\fP. ob_parse_dep() { local opt= -- cgit v0.9.1