docs: describe behavior of relative submodule URLs
Since the relative submodule URLs have been introduced in f31a522a2d, they do not conform to the rules for resolving relative URIs but rather to those of relative directories. Document that behavior. Signed-off-by: Jens Lehmann <Jens.Lehmann@web.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Jens Lehmann committed
Jan 1, 2012 at 16:13 UTC
9e6ed475e7a8d39350f102f0730d321de08e0585
1 file changed
+6
-1
Documentation/git-submodule.txt
+6
-1
@@ -79,7 +79,12 @@ to exist in the superproject. If <path> is not given, the
79
<repository> is the URL of the new submodule's origin repository.
80
This may be either an absolute URL, or (if it begins with ./
81
or ../), the location relative to the superproject's origin
82
-repository. If the superproject doesn't have an origin configured
82
+repository (Please note that to specify a repository 'foo.git'
83
+which is located right next to a superproject 'bar.git', you'll
84
+have to use '../foo.git' instead of './foo.git' - as one might expect
85
+when following the rules for relative URLs - because the evaluation
86
+of relative URLs in Git is identical to that of relative directories).
87
+If the superproject doesn't have an origin configured
88
the superproject is its own authoritative upstream and the current
89
working directory is used instead.
90
+