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

Signed-off-by: Stefan Beller <redacted>
---

 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

On Tue, Jul 19, 2016 at 4:45 PM, Stefan Beller [off-list ref] wrote:

Signed-off-by: Stefan Beller <redacted>
---

Any comment here?

On Mon, Jul 25, 2016 at 5:38 PM, Stefan Beller [off-list ref] wrote:

On Tue, Jul 19, 2016 at 4:45 PM, Stefan Beller [off-list ref] wrote:

quoted

Signed-off-by: Stefan Beller <redacted>
---

Any comment here?

I personally found it Meh in the sense that those who read
and followed the previous note would find it adding no new
information, and to those who don't bother the additional
note would not help very much because they would not
understand (and more importantly, would not care) where
that "this affects ALL submodules" comes from, or why
that leads to "so it is only useful...".

But it may be just me.

On Mon, Jul 25, 2016 at 5:43 PM, Junio C Hamano [off-list ref] wrote:

On Mon, Jul 25, 2016 at 5:38 PM, Stefan Beller [off-list ref] wrote:

quoted

On Tue, Jul 19, 2016 at 4:45 PM, Stefan Beller [off-list ref] wrote:

quoted

Signed-off-by: Stefan Beller <redacted>
---

Any comment here?

I personally found it Meh in the sense that those who read
and followed the previous note would find it adding no new
information, and to those who don't bother the additional
note would not help very much because they would not
understand (and more importantly, would not care) where
that "this affects ALL submodules" comes from, or why
that leads to "so it is only useful...".

But it may be just me.

Ok, I guess we can just drop it then.

Thanks,
Stefan