Merge branch 'nd/stream-more'

[git.git] / Documentation / gitmodules.txt

diff --git a/Documentation/gitmodules.txt b/Documentation/gitmodules.txt
index 5daf750d1942f3b97844b4ef378daf9346cb46d4..4e1fd52e7d230c8f5e55960e960a68ef5875fe76 100644 (file)
--- a/Documentation/gitmodules.txt
+++ b/Documentation/gitmodules.txt
@@ -28,7 +28,10 @@ submodule.<name>.path::
        be unique within the .gitmodules file.
 
 submodule.<name>.url::
-       Defines an url from where the submodule repository can be cloned.
+       Defines a URL from which the submodule repository can be cloned.
+       This may be either an absolute URL ready to be passed to
+       linkgit:git-clone[1] or (if it begins with ./ or ../) a location
+       relative to the superproject's origin repository.
 
 submodule.<name>.update::
        Defines what to do when the submodule is updated by the superproject.
@@ -41,6 +44,29 @@ submodule.<name>.update::
        This config option is overridden if 'git submodule update' is given
        the '--merge' or '--rebase' options.
 
+submodule.<name>.fetchRecurseSubmodules::
+       This option can be used to control recursive fetching of this
+       submodule. If this option is also present in the submodules entry in
+       .git/config of the superproject, the setting there will override the
+       one found in .gitmodules.
+       Both settings can be overridden on the command line by using the
+       "--[no-]recurse-submodules" option to "git fetch" and "git pull".
+
+submodule.<name>.ignore::
+       Defines under what circumstances "git status" and the diff family show
+       a submodule as modified. When set to "all", it will never be considered
+       modified, "dirty" will ignore all changes to the submodules work tree and
+       takes only differences between the HEAD of the submodule and the commit
+       recorded in the superproject into account. "untracked" will additionally
+       let submodules with modified tracked files in their work tree show up.
+       Using "none" (the default when this option is not set) also shows
+       submodules that have untracked files in their work tree as changed.
+       If this option is also present in the submodules entry in .git/config of
+       the superproject, the setting there will override the one found in
+       .gitmodules.
+       Both settings can be overridden on the command line by using the
+       "--ignore-submodule" option.
+
 
 EXAMPLES
 --------
@@ -58,16 +84,12 @@ Consider the following .gitmodules file:
 
 This defines two submodules, `libfoo` and `libbar`. These are expected to
 be checked out in the paths 'include/foo' and 'include/bar', and for both
-submodules an url is specified which can be used for cloning the submodules.
+submodules a URL is specified which can be used for cloning the submodules.
 
 SEE ALSO
 --------
 linkgit:git-submodule[1] linkgit:git-config[1]
 
-DOCUMENTATION
--------------
-Documentation by Lars Hjemli <hjemli@gmail.com>
-
 GIT
 ---
 Part of the linkgit:git[1] suite