diff options
Diffstat (limited to 'Documentation/gitmodules.txt')
| -rw-r--r-- | Documentation/gitmodules.txt | 19 |
1 files changed, 15 insertions, 4 deletions
diff --git a/Documentation/gitmodules.txt b/Documentation/gitmodules.txt index 035294e208..5daf750d19 100644 --- a/Documentation/gitmodules.txt +++ b/Documentation/gitmodules.txt @@ -7,7 +7,7 @@ gitmodules - defining submodule properties SYNOPSIS -------- -gitmodules +$GIT_WORK_DIR/.gitmodules DESCRIPTION @@ -15,7 +15,7 @@ DESCRIPTION The `.gitmodules` file, located in the top-level directory of a git working tree, is a text file with a syntax matching the requirements -of gitlink:git-config[1]. +of linkgit:git-config[1]. The file contains one subsection per submodule, and the subsection value is the name of the submodule. Each submodule section also contains the @@ -30,6 +30,17 @@ submodule.<name>.path:: submodule.<name>.url:: Defines an url from where the submodule repository can be cloned. +submodule.<name>.update:: + Defines what to do when the submodule is updated by the superproject. + If 'checkout' (the default), the new commit specified in the + superproject will be checked out in the submodule on a detached HEAD. + If 'rebase', the current branch of the submodule will be rebased onto + the commit specified in the superproject. If 'merge', the commit + specified in the superproject will be merged into the current branch + in the submodule. + This config option is overridden if 'git submodule update' is given + the '--merge' or '--rebase' options. + EXAMPLES -------- @@ -51,7 +62,7 @@ submodules an url is specified which can be used for cloning the submodules. SEE ALSO -------- -gitlink:git-submodule[1] gitlink:git-config[1] +linkgit:git-submodule[1] linkgit:git-config[1] DOCUMENTATION ------------- @@ -59,4 +70,4 @@ Documentation by Lars Hjemli <hjemli@gmail.com> GIT --- -Part of the gitlink:git[7] suite +Part of the linkgit:git[1] suite |