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 This may be either an absolute URL ready to be passed to 33 linkgit:git-clone[1] or (if it begins with ./ or ../) a location 34 relative to the superproject's origin repository. 35 36submodule.<name>.update:: 37 Defines what to do when the submodule is updated by the superproject. 38 If 'checkout' (the default), the new commit specified in the 39 superproject will be checked out in the submodule on a detached HEAD. 40 If 'rebase', the current branch of the submodule will be rebased onto 41 the commit specified in the superproject. If 'merge', the commit 42 specified in the superproject will be merged into the current branch 43 in the submodule. 44 This config option is overridden if 'git submodule update' is given 45 the '--merge' or '--rebase' options. 46 47 48EXAMPLES 49-------- 50 51Consider the following .gitmodules file: 52 53 [submodule "libfoo"] 54 path = include/foo 55 url = git://foo.com/git/lib.git 56 57 [submodule "libbar"] 58 path = include/bar 59 url = git://bar.com/git/lib.git 60 61 62This defines two submodules, `libfoo` and `libbar`. These are expected to 63be checked out in the paths 'include/foo' and 'include/bar', and for both 64submodules an url is specified which can be used for cloning the submodules. 65 66SEE ALSO 67-------- 68linkgit:git-submodule[1] linkgit:git-config[1] 69 70DOCUMENTATION 71------------- 72Documentation by Lars Hjemli <hjemli@gmail.com> 73 74GIT 75--- 76Part of the linkgit:git[1] suite