From 7e2285a48ac3d86a06a2d94d6c46fcf7011c7dfd Mon Sep 17 00:00:00 2001

From: Will Woods <wwoods@redhat.com>

Date: Fri, 27 Jul 2012 13:12:28 -0400

Subject: [PATCH] add comment for getargbool()

I always forget how getargbool works. Add a comment documenting it.

---

 modules.d/99base/dracut-lib.sh | 7 +++++++

 1 file changed, 7 insertions(+)

diff --git a/modules.d/99base/dracut-lib.sh b/modules.d/99base/dracut-lib.sh

index 2eb1224..3a7be9a 100755

--- a/modules.d/99base/dracut-lib.sh

+++ b/modules.d/99base/dracut-lib.sh

@@ -145,6 +145,13 @@ getarg() {

     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() {

     local _b

     unset _b