Re: [PATCH/RFC] Documentation: Say that submodule clones use a separate gitdirs.
From: Andrew Keller <hidden>
Date: 2016-06-15 23:00:14
On Mar 7, 2014, at 2:53 AM, Henri GEIST [off-list ref] wrote:
quoted hunk ↗ jump to hunk
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 <redacted> --- 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 thedifference 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. +
The modules directory is 'modules'. And, the '.git' folder is not always called '.git' -- in a submodule, for example, the directory name is the name of the module. Also, this file contains mostly high-level documentation, and this addition feels technical in nature. Is there a location for more technical documentation? Or, perhaps it can be reworded to sound less technical?
COMMANDS -------- -- 1.7.9.3.369.gd715.dirty --
- Andrew Keller