[X2Go-Commits] [buildscripts] 02/02: bin/common.sh: add or clarify comments for the first two shell functions.

[git-admin at x2go.org]

This is an automated email from the git hooks/post-receive script.

x2go pushed a commit to branch master
in repository buildscripts.

commit 533a9bbf00b5d3c0ce1ac7b3ced73513f9866621
Author: Mihai Moldovan <ionic at ionic.de>
Date:   Sun May 10 06:28:01 2015 +0200

    bin/common.sh: add or clarify comments for the first two shell functions.
---
 bin/common.sh |    7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/bin/common.sh b/bin/common.sh
index b20438d..9d77386 100644
--- a/bin/common.sh
+++ b/bin/common.sh
@@ -19,6 +19,10 @@
 
 export PATH="${HOME}/bin:${PATH}"
 
+# Takes a pseudo-boolean string representation and converts it into
+# either 0 or 1.
+# The result is printed as a string without a trailing newline.
+# The return code is always 0.
 function make_boolean () {
 	typeset -l OPTION="${1}"
 
@@ -33,7 +37,8 @@ function make_boolean () {
 }
 
 # Repeats an input string.
-# Returns the repeated input string.
+# Returns the repeated input string without a trailing newline.
+# The return code is always 0.
 repeat_str () { # INPUT COUNT
 	typeset INPUT="${1:?"Error: no input string passed to ${FUNCNAME}()."}"
 	typeset COUNT="${2:?"Error: no count passed to ${FUNCNAME}()."}"

--
Alioth's /srv/git/code.x2go.org/buildscripts.git//..//_hooks_/post-receive-email on /srv/git/code.x2go.org/buildscripts.git