Add file descriptions for submodule scripts (#1485)

project-chip · Jul 7, 2020 · 8f45112 · 8f45112
1 parent fd0e531
commit 8f45112
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 0 deletions.
diff --git a/scripts/helpers/pull_submodule.sh b/scripts/helpers/pull_submodule.sh
@@ -16,6 +16,8 @@
 # limitations under the License.
 #
 
+# Internal script for pull_submodules.sh. Not intended to be used directly.
+
 set -e
 
 CHIP_ROOT="$(dirname "$0")/../.."

diff --git a/scripts/helpers/pull_submodules.sh b/scripts/helpers/pull_submodules.sh
@@ -16,6 +16,9 @@
 # limitations under the License.
 #
 
+# Helper script to update all initialized submodules to the current tip of the
+# branch specified in .gitmodules.
+
 set -e
 
 CHIP_ROOT="$(dirname "$0")/../.."

diff --git a/scripts/helpers/rename_submodules.sh b/scripts/helpers/rename_submodules.sh
@@ -16,6 +16,9 @@
 # limitations under the License.
 #
 
+# Temporary transition script to remove submodules added with previous names
+# and re-add them with the new names.
+
 CHIP_ROOT="$(dirname "$0")/../.."
 
 if [[ ! -e "$CHIP_ROOT/.git" ]]; then
-Original file line number
+Diff line change
@@ Expand Up / @@ -16,6 +16,8 @@ @@
     # limitations under the License.
     #
+    # Internal script for pull_submodules.sh. Not intended to be used directly.
     set -e
     CHIP_ROOT="$(dirname "$0")/../.."
@@ Expand Down @@