gsu subcommand: Fix off-by-one bug in gsu_cword_is_option_parameter().

We define $n as the number of characters in the getopt string *minus one*,
so we must loop from 0 to $n, inclusively.

This patch also adds documentation of this public function.

diff --git a/misc/gsu/subcommand b/misc/gsu/subcommand
index 7ba4850b66baf62b34f5a5c1db7c47e48c50c641..84c0174ccbdaaf5b7ef8e22bb1a032b485b4c46e 100644 (file)
--- a/misc/gsu/subcommand
+++ b/misc/gsu/subcommand
@@ -434,6 +434,15 @@ EOF
        ret=$GSU_SUCCESS
 }
 
+# Find out if the current word is a parameter for an option.
+#
+# $1:   usual getopts option string.
+# $2:   The current word number.
+# $3..: All words of the current command line.
+#
+# return: If yes, $result contains the letter of the option for which the
+# current word is a parameter. Otherwise, $result is empty.
+#
 gsu_cword_is_option_parameter()
 {
        local opts="$1" cword="$2" prev i n
@@ -449,7 +458,7 @@ gsu_cword_is_option_parameter()
        [[ ! "$prev" == -* ]] && return
 
        n=$((${#opts} - 1))
-       for ((i=0; i < $n; i++)); do
+       for ((i=0; i <= $n; i++)); do
                opt="${opts:$i:1}"
                [[ "${opts:$(($i + 1)):1}" != ":" ]] && continue
                let i++