Re: [PATCH] Documentation, git submodule: Note about --reference

 Is it too obvious?
 I was approached off list and this was only obvious after some discussion,
 so I think it is a valid warning.

 On the other hand this might show that we want to get worktree working with
 submodules.

 Documentation/git-submodule.txt | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt
index bf3bb37..dcbd460 100644
--- a/Documentation/git-submodule.txt
+++ b/Documentation/git-submodule.txt

@@ -373,6 +373,10 @@ the submodule itself.
 +
 *NOTE*: Do *not* use this option unless you have read the note
 for linkgit:git-clone[1]'s `--reference` and `--shared` options carefully.
++
+*NOTE*: This gives the same reference to all submodules, so it is only useful
+if you are tracking different versions of a project in submodules instead
+of different projects.

 --recursive::
        This option is only valid for foreach, update, status and sync commands.
--

2.9.2.800.g213104a