Add some submod bads. jand++

ingydotnet · Jan 28, 2015 · a3f2e53 · a3f2e53
1 parent 3270e22
commit a3f2e53
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/Intro.pod b/Intro.pod
@@ -108,6 +108,10 @@ Bad:
 
 =item * Pulling a repo with submodules won't pull in the new submodule changes.
 
+=item * A submodule will break if the referenced repo goes away.
+
+=item * A submodule will break if a forced push removes the referenced commit.
+
 =item * Can't use different submodules/commits per main project branch.
 
 =item * Can't "try out" a submodule on alternate branch.

diff --git a/doc/intro-to-subrepo.swim b/doc/intro-to-subrepo.swim
@@ -77,6 +77,8 @@ Bad:
 * Users have to know a repo has submodules.
 * Users have to get the subrepos manually.
 * Pulling a repo with submodules won't pull in the new submodule changes.
+* A submodule will break if the referenced repo goes away.
+* A submodule will break if a forced push removes the referenced commit.
 * Can't use different submodules/commits per main project branch.
 * Can't "try out" a submodule on alternate branch.
 * Main repo can be pushed upstream pointing to unpushed submod commits.