git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Henri GEIST <geist.henri@laposte.net>
To: git@vger.kernel.org
Cc: Junio C Hamano <gitster@pobox.com>, Jens Lehmann <Jens.Lehmann@web.de>
Subject: [PATCH/RFC] Documentation: Say that submodule clones use a separate gitdirs.
Date: Fri, 07 Mar 2014 08:53:54 +0100	[thread overview]
Message-ID: <1394178834.7891.38.camel@Naugrim> (raw)

Adding a note in the submodule documentation signaling that the
automatically cloned missing submodules are cloned with a separate
gitdir. And where it is put.

Signed-off-by: Henri GEIST <geist.henri@laposte.net>
---
 Documentation/git-submodule.txt |    5 +++++
 1 file changed, 5 insertions(+)

diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt
index 21cb59a..ea837fd 100644
--- a/Documentation/git-submodule.txt
+++ b/Documentation/git-submodule.txt
@@ -64,6 +64,11 @@ using the 'status' subcommand and get a detailed overview of the
 difference between the index and checkouts using the 'summary'
 subcommand.
 
+*NOTE*: when submodule add or submodule update commands clone a missing
+submodule, the option --separate-git-dir is passed to the clone command
+and the gitdir of the submodule is placed outside of its working
+directory in the .git/module of the current repository.
+
 
 COMMANDS
 --------
-- 
1.7.9.3.369.gd715.dirty

             reply	other threads:[~2014-03-07  7:54 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-03-07  7:53 Henri GEIST [this message]
2014-03-07 21:42 ` [PATCH/RFC] Documentation: Say that submodule clones use a separate gitdirs Andrew Keller
2014-03-07 22:19   ` Junio C Hamano
2014-03-07 22:35   ` Henri GEIST
2014-03-07 23:37     ` Junio C Hamano
2014-03-08  0:50       ` Henri GEIST
2014-03-09 23:24         ` Andrew Keller
2014-03-10  7:52           ` Henri GEIST
2014-03-10 15:31           ` Junio C Hamano
2014-03-10 18:22             ` Henri GEIST
2014-03-10 19:36               ` Junio C Hamano

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=1394178834.7891.38.camel@Naugrim \
    --to=geist.henri@laposte.net \
    --cc=Jens.Lehmann@web.de \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    /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).