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 the default update procedure for the named submodule, 42 i.e. how the submodule is updated by "git submodule update" 43 command in the superproject. This is only used by `git 44 submodule init` to initialize the configuration variable of 45 the same name. Allowed values here are 'checkout', 'rebase', 46 'merge' or 'none'. See description of 'update' command in 47 linkgit:git-submodule[1] for their meaning. Note that the 48 '!command' form is intentionally ignored here for security 49 reasons. 50 51submodule.<name>.branch:: 52 A remote branch name for tracking updates in the upstream submodule. 53 If the option is not specified, it defaults to 'master'. A special 54 value of `.` is used to indicate that the name of the branch in the 55 submodule should be the same name as the current branch in the 56 current repository. See the `--remote` documentation in 57 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. The following values are supported: 70+ 71-- 72 all;; The submodule will never be considered modified (but will 73 nonetheless show up in the output of status and commit when it has 74 been staged). 75 76 dirty;; All changes to the submodule's work tree will be ignored, only 77 committed differences between the HEAD of the submodule and its 78 recorded state in the superproject are taken into account. 79 80 untracked;; Only untracked files in submodules will be ignored. 81 Committed differences and modifications to tracked files will show 82 up. 83 84 none;; No modifiations to submodules are ignored, all of committed 85 differences, and modifications to tracked and untracked files are 86 shown. This is the default option. 87 88If this option is also present in the submodules entry in .git/config 89of the superproject, the setting there will override the one found in 90.gitmodules. 91 92Both settings can be overridden on the command line by using the 93"--ignore-submodule" option. The 'git submodule' commands are not 94affected by this setting. 95-- 96 97submodule.<name>.shallow:: 98 When set to true, a clone of this submodule will be performed as a 99 shallow clone (with a history depth of 1) unless the user explicitly 100 asks for a non-shallow clone. 101 102 103EXAMPLES 104-------- 105 106Consider the following .gitmodules file: 107 108 [submodule "libfoo"] 109 path = include/foo 110 url = git://foo.com/git/lib.git 111 112 [submodule "libbar"] 113 path = include/bar 114 url = git://bar.com/git/lib.git 115 116 117This defines two submodules, `libfoo` and `libbar`. These are expected to 118be checked out in the paths 'include/foo' and 'include/bar', and for both 119submodules a URL is specified which can be used for cloning the submodules. 120 121SEE ALSO 122-------- 123linkgit:git-submodule[1] linkgit:git-config[1] 124 125GIT 126--- 127Part of the linkgit:git[1] suite