[PATCH] clarify need for init in git-submodules documentation
As per the discussion in this thread:
http://marc.info/?t=118721709500008&r=1&w=2
this patch updates the git-submodules documentation to make the situation a bit clearer.
Signed-off-by: martin f. krafft <madduck@madduck.net>
---
Documentation/git-submodule.txt | 23 +++++++++++++++--------
1 files changed, 15 insertions(+), 8 deletions(-)
diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt
index 2c48936..b1a4f95 100644
--- a/Documentation/git-submodule.txt
+++ b/Documentation/git-submodule.txt
@@ -32,15 +32,17 @@ status::
repository. This command is the default command for git-submodule.
init::
- Initialize the submodules, i.e. register in .git/config each submodule
- name and url found in .gitmodules. The key used in .git/config is
- `submodule.$name.url`. This command does not alter existing information
- in .git/config.
+ Initialize the submodules, i.e. register in $GIT_DIR/config each
+ submodule name and url found in .gitmodules. The key used in
+ $GIT_DIR/config is `submodule.$name.url`. This command does not alter
+ existing information in $GIT_DIR/config, it only serves to initialise
+ the local configuration from the defaults in .gitmodules.
update::
- Update the registered submodules, i.e. clone missing submodules and
- checkout the commit specified in the index of the containing repository.
- This will make the submodules HEAD be detached.
+ Update the submodules registered in $GIT_DIR/config, i.e. clone
+ missing submodules and checkout the commit specified in the index of
+ the containing repository. This will make the submodules HEAD be
+ detached.
OPTIONS
@@ -64,9 +66,14 @@ FILES
-----
When initializing submodules, a .gitmodules file in the top-level directory
of the containing repository is used to find the url of each submodule.
-This file should be formatted in the same way as $GIR_DIR/config. The key
+This file should be formatted in the same way as $GIT_DIR/config. The key
to each submodule url is "submodule.$name.url".
+The file .gitmodules serves default configuration data to users who cloned the
+repository. In order to work with submodules, these data need to be copied to
+$GIT_DIR/config with `git-submodule init`. Only the data in $GIT_DIR/config
+are used for `git-submodule update`.
+
AUTHOR
------
--
1.5.3.rc5.1.g44065