Comment function files

This provides global variable comments for various function files, as
well as license info and the #!/bin/bash lines so that gerrit will
syntax highlight correctly.

Change-Id: Ice55aff1e39084a55e1a3da6d6418a103df4d04f

functions

@@ -1,7 +1,26 @@
+#!/bin/bash
+#
+# Copyright 2015 Hewlett-Packard Development Company, L.P.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+#
+#
 # functions - Grenade-specific functions
 #
 # The following variables are assumed to be defined by certain functions:
 #
+# - ``GRENADE_DIR``
+# - ``TARGET_DEVSTACK_DIR``
 # - ``MYSQL_PASSWORD``
 # - ``SAVE_DIR``
 

inc/bootstrap

@@ -23,6 +23,23 @@
 # us a working DEVSTACK_TARGET which then lets us pivot our
 # functionality into there. Most of these will have been manually
 # copied from upstream devstack.
+#
+# The following variables are assumed to be defined by certain functions:
+#
+# - ``GRENADE_DIR``
+# - ``STACK_ROOT``
+# - ``BASE_DEVSTACK_DIR``
+# - ``BASE_DEVSTACK_BRANCH``
+# - ``TARGET_DEVSTACK_DIR``
+# - ``TARGET_DEVSTACK_BRANCH``
+#
+# for git related functions
+#
+# - ``RECLONE``
+# - ``OFFLINE``
+# - ``ERROR_ON_CLONE``
+# - ``GIT_TIMEOUT``
+
 
 # Echo to summary log file
 #

inc/plugin

@@ -13,6 +13,16 @@
 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 # License for the specific language governing permissions and limitations
 # under the License.
+#
+# Functions related to grenade plugins
+#
+# The following variables are assumed to be defined by certain functions:
+#
+# - ``GRENADE_DIR``
+# - ``SAVE_DIR``
+# - ``UPGRADE_PROJECTS``
+# - ``PLUGIN_DIR``
+# - ``BASE_DEVSTACK_DIR``
 
 GRENADE_DB=$SAVE_DIR/grenade_db.ini
 

inc/upgrade

@@ -14,6 +14,14 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 
+# The following variables are assumed to be defined by certain functions:
+#
+# - ``GRENADE_DIR``
+# - ``TARGET_DEVSTACK_DIR``
+# - ``SCREEN_LOGDIR``
+# - ``PLUGIN_DIR``
+# - ``MYSQL_PASSWORD``
+
 DATABASES_TO_SAVE=""
 
 # save_data