[PATCH modular 04/10] Document functions in build.sh.

[Trevor Woerner]

From: Trevor Woerner <twoerner at gmail.com>

Provide explanations of functioning and behaviour for some of the functions
in build.sh script.

Signed-off-by: Trevor Woerner <twoerner at gmail.com>
---
 build.sh |   31 +++++++++++++++++++++++++++++++
 1 files changed, 31 insertions(+), 0 deletions(-)

diff --git a/build.sh b/build.sh
index 2bfcebb..07cdea0 100755
--- a/build.sh
+++ b/build.sh
@@ -65,6 +65,13 @@ failed_components=""
 nonexistent_components=""
 clonefailed_components=""
 
+# explain where a failured occurred
+# if you find this message in the build output it can help tell you where the failure occurred
+# arguments:
+#   $1 - which command failed
+#   $2/$3 - which module/component failed
+# returns:
+#   (irrelevant)
 failed() {
     echo "***** $1 failed on $2/$3"
     failed_components="$failed_components $2/$3"
@@ -157,6 +164,15 @@ checkfortars() {
     return 0
 }
 
+# perform a clone of a git repository
+# this function provides the mapping between module/component names
+# and their location in the fd.o repository
+# arguments:
+#   $1 - module
+#   $2 - component (optional)
+# returns:
+#   0 - good
+#   1 - bad
 clone() {
     case $1 in
         "pixman")
@@ -192,6 +208,13 @@ clone() {
     return 0
 }
 
+# perform processing of each module/component
+# arguments:
+#   $1 - module
+#   $2 - component (optional)
+# returns:
+#   0 - good
+#   1 - bad
 process() {
     local rtn
 
@@ -357,6 +380,14 @@ process() {
     return 0
 }
 
+# process each module/component and handle:
+# LISTONLY, RESUME, NOQUIT, and BUILD_ONE
+# arguments:
+#   $1 - module
+#   $2 - component (optional)
+# returns:
+#   0 - good
+#   1 - bad
 build() {
     if [ X"$LISTONLY" != X ]; then
 	echo "$1/$2"
-- 
1.7.3.1.45.g9855b