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 a URL from which 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 47submodule.<name>.fetchRecurseSubmodules:: 48 This option can be used to control recursive fetching of this 49 submodule. If this option is also present in the submodules entry in 50 .git/config of the superproject, the setting there will override the 51 one found in .gitmodules. 52 Both settings can be overridden on the command line by using the 53 "--[no-]recurse-submodules" option to "git fetch" and "git pull". 54 55submodule.<name>.ignore:: 56 Defines under what circumstances "git status" and the diff family show 57 a submodule as modified. When set to "all", it will never be considered 58 modified, "dirty" will ignore all changes to the submodules work tree and 59 takes only differences between the HEAD of the submodule and the commit 60 recorded in the superproject into account. "untracked" will additionally 61 let submodules with modified tracked files in their work tree show up. 62 Using "none" (the default when this option is not set) also shows 63 submodules that have untracked files in their work tree as changed. 64 If this option is also present in the submodules entry in .git/config of 65 the superproject, the setting there will override the one found in 66 .gitmodules. 67 Both settings can be overridden on the command line by using the 68 "--ignore-submodule" option. 69 70 71EXAMPLES 72-------- 73 74Consider the following .gitmodules file: 75 76 [submodule "libfoo"] 77 path = include/foo 78 url = git://foo.com/git/lib.git 79 80 [submodule "libbar"] 81 path = include/bar 82 url = git://bar.com/git/lib.git 83 84 85This defines two submodules, `libfoo` and `libbar`. These are expected to 86be checked out in the paths 'include/foo' and 'include/bar', and for both 87submodules a URL is specified which can be used for cloning the submodules. 88 89SEE ALSO 90-------- 91linkgit:git-submodule[1] linkgit:git-config[1] 92 93GIT 94--- 95Part of the linkgit:git[1] suite