From a53e0cbe304dca54ec9c82e59e7b642769be9242 Mon Sep 17 00:00:00 2001 From: Patrick McDermott Date: Mon, 18 Mar 2019 15:59:30 -0400 Subject: ob_set_substvar(): Rename to ob_set_source_substvar() --- (limited to 'lib/control.sh') diff --git a/lib/control.sh b/lib/control.sh index 94314f3..b5cc5d6 100644 --- a/lib/control.sh +++ b/lib/control.sh @@ -177,9 +177,9 @@ ob_parse_control() return 0 } -## @brief Set a substitution variable -## @details \fBob_set_substvar\fP() sets a substitution variable for later use -## by \fBob_substvars\fP(3). +## @brief Set a source package substitution variable +## @details \fBob_set_source_substvar\fP() sets a source package substitution +## variable for later use by \fBob_substvars\fP(3). ## @operand name req The name of the substitution variable. May only consist ## of uppercase and lowercase Latin letters, digits, and ## hyphens and must be at least one character long. @@ -187,7 +187,7 @@ ob_parse_control() ## @return Returns 0 on success, or 1 if \fIname\fP is empty or contains invalid ## characters. ## @pure no This function sets an internal global variable. -ob_set_substvar() +ob_set_source_substvar() { local name="${1}" local value="${2}" @@ -223,8 +223,9 @@ ob_set_substvar() ## @brief Substitute variables in text ## @details \fBob_substvars\fP() substitutes variables previously set with -## \fBob_set_substvar\fP(3) in a string. The format for variable -## substitutions is \fI${var}\fP, and substitutions can be nested. +## \fBob_set_source_substvar\fP(3) in a string. The format for +## variable substitutions is \fI${var}\fP, and substitutions can be +## nested. ## @operand string req The string in which to substitute variables. ## @return Returns 0 on success or 1 on possible recursion. ## @stderr Prints a warning on possible recursion. -- cgit v0.9.1