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. The name is set to the path where the 22submodule has been added unless it was customized with the '--name' 23option of 'git submodule add'. Each submodule section also contains the 24following required keys: 25 26submodule.<name>.path:: 27 Defines the path, relative to the top-level directory of the git 28 working tree, where the submodule is expected to be checked out. 29 The path name must not end with a `/`. All submodule paths must 30 be unique within the .gitmodules file. 31 32submodule.<name>.url:: 33 Defines a URL from which the submodule repository can be cloned. 34 This may be either an absolute URL ready to be passed to 35 linkgit:git-clone[1] or (if it begins with ./ or ../) a location 36 relative to the superproject's origin repository. 37 38submodule.<name>.update:: 39 Defines what to do when the submodule is updated by the superproject. 40 If 'checkout' (the default), the new commit specified in the 41 superproject will be checked out in the submodule on a detached HEAD. 42 If 'rebase', the current branch of the submodule will be rebased onto 43 the commit specified in the superproject. If 'merge', the commit 44 specified in the superproject will be merged into the current branch 45 in the submodule. 46 If 'none', the submodule with name `$name` will not be updated 47 by default. 48 49 This config option is overridden if 'git submodule update' is given 50 the '--merge', '--rebase' or '--checkout' options. 51 52submodule.<name>.fetchRecurseSubmodules:: 53 This option can be used to control recursive fetching of this 54 submodule. If this option is also present in the submodules entry in 55 .git/config of the superproject, the setting there will override the 56 one found in .gitmodules. 57 Both settings can be overridden on the command line by using the 58 "--[no-]recurse-submodules" option to "git fetch" and "git pull". 59 60submodule.<name>.ignore:: 61 Defines under what circumstances "git status" and the diff family show 62 a submodule as modified. When set to "all", it will never be considered 63 modified, "dirty" will ignore all changes to the submodules work tree and 64 takes only differences between the HEAD of the submodule and the commit 65 recorded in the superproject into account. "untracked" will additionally 66 let submodules with modified tracked files in their work tree show up. 67 Using "none" (the default when this option is not set) also shows 68 submodules that have untracked files in their work tree as changed. 69 If this option is also present in the submodules entry in .git/config of 70 the superproject, the setting there will override the one found in 71 .gitmodules. 72 Both settings can be overridden on the command line by using the 73 "--ignore-submodule" option. 74 75 76EXAMPLES 77-------- 78 79Consider the following .gitmodules file: 80 81 [submodule "libfoo"] 82 path = include/foo 83 url = git://foo.com/git/lib.git 84 85 [submodule "libbar"] 86 path = include/bar 87 url = git://bar.com/git/lib.git 88 89 90This defines two submodules, `libfoo` and `libbar`. These are expected to 91be checked out in the paths 'include/foo' and 'include/bar', and for both 92submodules a URL is specified which can be used for cloning the submodules. 93 94SEE ALSO 95-------- 96linkgit:git-submodule[1] linkgit:git-config[1] 97 98GIT 99--- 100Part of the linkgit:git[1] suite