summaryrefslogtreecommitdiffstats
path: root/Documentation/gitmodules.txt
diff options
context:
space:
mode:
authorJonathan Nieder <jrnieder@gmail.com>2010-07-15 09:41:55 +0200
committerJunio C Hamano <gitster@pobox.com>2010-07-15 20:59:57 +0200
commit47dc5d5fda291bc399da54648ca27e8df4ddfd2c (patch)
tree7d5c046b45ea250901f970a585b42880db5c399b /Documentation/gitmodules.txt
parentgitweb: fix esc_url (diff)
downloadgit-47dc5d5fda291bc399da54648ca27e8df4ddfd2c.tar.xz
git-47dc5d5fda291bc399da54648ca27e8df4ddfd2c.zip
gitmodules.5: url can be a relative path
There is already excellent documentation for this facility in git-submodule.1, but it is not so discoverable. Relative paths in .gitmodules can be useful for serving the same repository over multiple protocols, for example. Thanks to Peter for pointing this out. Cc: Peter Krefting <peter@softwolves.pp.se> Signed-off-by: Jonathan Nieder <jrnieder@gmail.com> Acked-by: Johan Herland <johan@herland.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/gitmodules.txt')
-rw-r--r--Documentation/gitmodules.txt3
1 files changed, 3 insertions, 0 deletions
diff --git a/Documentation/gitmodules.txt b/Documentation/gitmodules.txt
index 5daf750d19..72a13d18e0 100644
--- a/Documentation/gitmodules.txt
+++ b/Documentation/gitmodules.txt
@@ -29,6 +29,9 @@ submodule.<name>.path::
submodule.<name>.url::
Defines an url from where the submodule repository can be cloned.
+ This may be either an absolute URL ready to be passed to
+ linkgit:git-clone[1] or (if it begins with ./ or ../) a location
+ relative to the superproject's origin repository.
submodule.<name>.update::
Defines what to do when the submodule is updated by the superproject.