1gitmodules(5) 2============= 3 4NAME 5---- 6gitmodules - defining submodule properties 7 8SYNOPSIS 9-------- 10$GIT_WORK_DIR/.gitmodules 11 12 13DESCRIPTION 14----------- 15 16The `.gitmodules` file, located in the top-level directory of a git 17working tree, is a text file with a syntax matching the requirements 18of linkgit:git-config[1]. 19 20The file contains one subsection per submodule, and the subsection value 21is the name of the submodule. Each submodule section also contains the 22following required keys: 23 24submodule.<name>.path:: 25 Defines the path, relative to the top-level directory of the git 26 working tree, where the submodule is expected to be checked out. 27 The path name must not end with a `/`. All submodule paths must 28 be unique within the .gitmodules file. 29 30submodule.<name>.url:: 31 Defines an url from where the submodule repository can be cloned. 32 33submodule.<name>.update:: 34 Defines what to do when the submodule is updated by the superproject. 35 If 'checkout' (the default), the new commit specified in the 36 superproject will be checked out in the submodule on a detached HEAD. 37 If 'rebase', the current branch of the submodule will be rebased onto 38 the commit specified in the superproject. If 'merge', the commit 39 specified in the superproject will be merged into the current branch 40 in the submodule. 41 This config option is overridden if 'git submodule update' is given 42 the '--merge' or '--rebase' options. 43 44 45EXAMPLES 46-------- 47 48Consider the following .gitmodules file: 49 50 [submodule "libfoo"] 51 path = include/foo 52 url = git://foo.com/git/lib.git 53 54 [submodule "libbar"] 55 path = include/bar 56 url = git://bar.com/git/lib.git 57 58 59This defines two submodules, `libfoo` and `libbar`. These are expected to 60be checked out in the paths 'include/foo' and 'include/bar', and for both 61submodules an url is specified which can be used for cloning the submodules. 62 63SEE ALSO 64-------- 65linkgit:git-submodule[1] linkgit:git-config[1] 66 67DOCUMENTATION 68------------- 69Documentation by Lars Hjemli <hjemli@gmail.com> 70 71GIT 72--- 73Part of the linkgit:git[1] suite