git-submodule.txt: Clarify 'init' and 'add' subcommands.
Describe how 'add' sets the submodule's logical name, which is used in the configuration entry names. Clarify that 'init' only sets up the configuration entries for submodules that have already been added elsewhere. Describe that <path> arguments limit the submodules that are configured. Signed-off-by: Dale Worley <worley@ariadne.com> Acked-by: Jens Lehmann <Jens.Lehmann@web.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Dale R. Worley committed
May 15, 2013 at 18:28 UTC
3244eb9b5a6f0b5a06d20c06dbb34739fa3b043a
1 file changed
+6
-2
Documentation/git-submodule.txt
+6
-2
@@ -77,6 +77,8 @@ argument <path> is the relative location for the cloned submodule
77
to exist in the superproject. If <path> is not given, the
78
"humanish" part of the source repository is used ("repo" for
79
"/path/to/repo.git" and "foo" for "host.xz:foo/.git").
80
+The <path> is also used as the submodule's logical name in its
81
+configuration entries unless `--name` is used to specify a logical name.
82
+
83
<repository> is the URL of the new submodule's origin repository.
84
This may be either an absolute URL, or (if it begins with ./
@@ -124,8 +126,10 @@ linkgit:git-status[1] and linkgit:git-diff[1] will provide that information
126
too (and can also report changes to a submodule's work tree).
127
128
init::
127
- Initialize the submodules, i.e. register each submodule name
128
- and url found in .gitmodules into .git/config.
129
+ Initialize the submodules recorded in the index (which were
130
+ added and committed elsewhere) by copying submodule
131
+ names and urls from .gitmodules to .git/config.
132
+ Optional <path> arguments limit which submodules will be initialized.
133
It will also copy the value of `submodule.$name.update` into
134
.git/config.
135
The key used in .git/config is `submodule.$name.url`.