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 38In addition, there are a number of optional keys: 39 40submodule.<name>.update:: 41 Defines what to do when the submodule is updated by the superproject. 42 If 'checkout' (the default), the new commit specified in the 43 superproject will be checked out in the submodule on a detached HEAD. 44 If 'rebase', the current branch of the submodule will be rebased onto 45 the commit specified in the superproject. If 'merge', the commit 46 specified in the superproject will be merged into the current branch 47 in the submodule. 48 If 'none', the submodule with name `$name` will not be updated 49 by default. 50 51 This config option is overridden if 'git submodule update' is given 52 the '--merge', '--rebase' or '--checkout' options. 53 54submodule.<name>.branch:: 55 A remote branch name for tracking updates in the upstream submodule. 56 If the option is not specified, it defaults to 'master'. See the 57 `--remote` documentation in linkgit:git-submodule[1] for details. 58 59submodule.<name>.fetchRecurseSubmodules:: 60 This option can be used to control recursive fetching of this 61 submodule. If this option is also present in the submodules entry in 62 .git/config of the superproject, the setting there will override the 63 one found in .gitmodules. 64 Both settings can be overridden on the command line by using the 65 "--[no-]recurse-submodules" option to "git fetch" and "git pull". 66 67submodule.<name>.ignore:: 68 Defines under what circumstances "git status" and the diff family show 69 a submodule as modified. When set to "all", it will never be considered 70 modified (but will nonetheless show up in the output of status and 71 commit when it has been staged), "dirty" will ignore all changes 72 to the submodules work tree and 73 takes only differences between the HEAD of the submodule and the commit 74 recorded in the superproject into account. "untracked" will additionally 75 let submodules with modified tracked files in their work tree show up. 76 Using "none" (the default when this option is not set) also shows 77 submodules that have untracked files in their work tree as changed. 78 If this option is also present in the submodules entry in .git/config of 79 the superproject, the setting there will override the one found in 80 .gitmodules. 81 Both settings can be overridden on the command line by using the 82 "--ignore-submodule" option. The 'git submodule' commands are not 83 affected by this setting. 84 85 86EXAMPLES 87-------- 88 89Consider the following .gitmodules file: 90 91 [submodule "libfoo"] 92 path = include/foo 93 url = git://foo.com/git/lib.git 94 95 [submodule "libbar"] 96 path = include/bar 97 url = git://bar.com/git/lib.git 98 99 100This defines two submodules, `libfoo` and `libbar`. These are expected to 101be checked out in the paths 'include/foo' and 'include/bar', and for both 102submodules a URL is specified which can be used for cloning the submodules. 103 104SEE ALSO 105-------- 106linkgit:git-submodule[1] linkgit:git-config[1] 107 108GIT 109--- 110Part of the linkgit:git[1] suite