Documentation/config: add information for core.splitIndex
[gitweb.git] / Documentation / gitmodules.txt
index ac70eca321cd1747e2916646c691ac18cb4dbd97..8f7c50f330f36f625951db7f4cc4657a31fa7113 100644 (file)
@@ -19,7 +19,7 @@ of linkgit:git-config[1].
 
 The file contains one subsection per submodule, and the subsection value
 is the name of the submodule. The name is set to the path where the
-submodule has been added unless it was customized with the '--name'
+submodule has been added unless it was customized with the `--name`
 option of 'git submodule add'. Each submodule section also contains the
 following required keys:
 
@@ -50,8 +50,11 @@ submodule.<name>.update::
 
 submodule.<name>.branch::
        A remote branch name for tracking updates in the upstream submodule.
-       If the option is not specified, it defaults to 'master'.  See the
-       `--remote` documentation in linkgit:git-submodule[1] for details.
+       If the option is not specified, it defaults to 'master'.  A special
+       value of `.` is used to indicate that the name of the branch in the
+       submodule should be the same name as the current branch in the
+       current repository.  See the `--remote` documentation in
+       linkgit:git-submodule[1] for details.
 
 submodule.<name>.fetchRecurseSubmodules::
        This option can be used to control recursive fetching of this
@@ -79,6 +82,11 @@ submodule.<name>.ignore::
        "--ignore-submodule" option. The 'git submodule' commands are not
        affected by this setting.
 
+submodule.<name>.shallow::
+       When set to true, a clone of this submodule will be performed as a
+       shallow clone unless the user explicitly asks for a non-shallow
+       clone.
+
 
 EXAMPLES
 --------