From: "martin f. krafft" <madduck@madduck.net>
To: git@vger.kernel.org
Cc: hjemli@gmail.com, skimo@liacs.nl
Subject: [PATCH] Clarify role of init command in git-submodules documentation
Date: Mon, 20 Aug 2007 09:09:44 +0200 [thread overview]
Message-ID: <11875937841178-git-send-email-madduck@madduck.net> (raw)
In-Reply-To: <20070817103652.GK1070MdfPADPa@greensroom.kotnet.org>
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 and documents the intended workflow.
Signed-off-by: martin f. krafft <madduck@madduck.net>
---
Documentation/git-submodule.txt | 30 +++++++++++++++++++-----------
1 files changed, 19 insertions(+), 11 deletions(-)
diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt
index 2c48936..8bc818a 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
@@ -62,10 +64,16 @@ OPTIONS
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
-to each submodule url is "submodule.$name.url".
+To work with submodules, a user has to prepare a repository clone with the
+command `git-submodule init`. This command copies the url of each submodule
+listed in the .gitmodules file in the top-level directory of the containing
+repository to $GIT_DIR/config. The key to each submodule url is
+"submodule.$name.url".
+
+The .gitmodules file then specifies the location of each submodule with
+respect to the repository (and is shared among all contributors), while the
+url of each submodule comes from the local configuration in $GIT_DIR/config
+and can thus be modified independently of all other users.
AUTHOR
--
1.5.3.rc5.40.g2f82
next prev parent reply other threads:[~2007-08-20 7:10 UTC|newest]
Thread overview: 20+ messages / expand[flat|nested] mbox.gz Atom feed top
2007-08-15 16:20 git submodule init and redundant data in .gitmodules/.git/config martin f krafft
2007-08-15 16:38 ` Sven Verdoolaege
2007-08-15 22:29 ` using .gitmodule as default (was: git submodule init and redundant data in .gitmodules/.git/config) martin f krafft
2007-08-16 13:53 ` Josef Weidendorfer
2007-08-16 14:21 ` martin f krafft
2007-08-16 16:39 ` Josef Weidendorfer
2007-08-16 18:10 ` [PATCH] clarify need for init in git-submodules documentation martin f. krafft
2007-08-17 9:31 ` Sven Verdoolaege
2007-08-17 10:08 ` martin f krafft
2007-08-17 10:36 ` Sven Verdoolaege
2007-08-20 7:09 ` martin f. krafft [this message]
2007-08-20 7:54 ` [PATCH] Clarify role of init command " Sven Verdoolaege
2007-08-21 18:02 ` martin f krafft
2007-08-21 20:25 ` Sven Verdoolaege
2007-08-21 21:03 ` martin f krafft
2007-08-22 8:30 ` Sven Verdoolaege
2007-08-22 13:48 ` martin f krafft
2007-08-20 21:14 ` Junio C Hamano
2007-08-20 9:29 ` Not setting M-F-T, keeping people on Cc (was: [PATCH] clarify need for init in git-submodules documentation) martin f krafft
2007-08-17 7:14 ` using .gitmodule as default (was: git submodule init and redundant data in .gitmodules/.git/config) Lars Hjemli
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=11875937841178-git-send-email-madduck@madduck.net \
--to=madduck@madduck.net \
--cc=git@vger.kernel.org \
--cc=hjemli@gmail.com \
--cc=skimo@liacs.nl \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).