add comment for getargbool()

I always forget how getargbool works. Add a comment documenting it.
master
Will Woods 2012-07-27 13:12:28 -04:00 committed by Harald Hoyer
parent 3e964eeb96
commit 7e2285a48a
1 changed files with 7 additions and 0 deletions

View File

@ -145,6 +145,13 @@ getarg() {
return 1 return 1
} }


# getargbool <defaultval> <args...>
# False if "getarg <args...>" returns "0", "no", or "off".
# True if getarg returns any other non-empty string.
# If not found, assumes <defaultval> - usually 0 for false, 1 for true.
# example: getargbool 0 rd.info
# true: rd.info, rd.info=1, rd.info=xxx
# false: rd.info=0, rd.info=off, rd.info not present (default val is 0)
getargbool() { getargbool() {
local _b local _b
unset _b unset _b