add notes to git scripts

diff --git a/link_git_modules b/link_git_modules
index e08639c69a09d0a9728906fe717299a3f8ce76b9..8f95346f069c2ac6add045958cf33b4b6be31b7b 100755 (executable)
--- a/link_git_modules
+++ b/link_git_modules
@@ -1,5 +1,11 @@
 #!/bin/sh
 
+# This command sets up any git submodules in the project.
+# Generally, this only needs to be run once on a freshly cloned
+# project, but won't harm anything if run later, provided
+# you modify it to accomodate any submodules that should *NOT*
+# be on the `master` branch.
+
 git submodule init
 
 git submodule update

diff --git a/update_git_modules b/update_git_modules
index ff78f96c3be5307afeb402d8da24d8b256c7274d..9d1c46bda939f70543ad644d888df2ccc73b7291 100755 (executable)
--- a/update_git_modules
+++ b/update_git_modules
@@ -1,3 +1,7 @@
 #!/bin/sh
 
+# This command can be run any time to ensure that all submodules are on
+# the most recent commit for the configured branch, as set up
+# in the `link_git_modules` script.
+
 git submodule foreach git pull origin