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