From: Fletcher T. Penney <fletcher@fletcherpenney.net>
Date: Thu, 12 Nov 2015 14:31:28 +0000 (-0500)
Subject: add notes to git scripts
X-Git-Tag: 0.1.0a~22
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=b10603b1fa079b1d4f60ea33673c51520f2122e1;p=multimarkdown

add notes to git scripts
---

diff --git a/link_git_modules b/link_git_modules
index e08639c..8f95346 100755
--- 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 ff78f96..9d1c46b 100755
--- 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