]>
Commit | Line | Data |
---|---|---|
70c7ac22 LH |
1 | git-submodule(1) |
2 | ================ | |
3 | ||
4 | NAME | |
5 | ---- | |
6 | git-submodule - Initialize, update or inspect submodules | |
7 | ||
8 | ||
9 | SYNOPSIS | |
10 | -------- | |
b2493649 | 11 | [verse] |
68cabbfd | 12 | 'git submodule' [--quiet] [--cached] |
eb2f2f5f | 13 | 'git submodule' [--quiet] add [<options>] [--] <repository> [<path>] |
64b19ffe | 14 | 'git submodule' [--quiet] status [--cached] [--recursive] [--] [<path>...] |
b1889c36 | 15 | 'git submodule' [--quiet] init [--] [<path>...] |
f6a52799 | 16 | 'git submodule' [--quiet] deinit [-f|--force] (--all|[--] <path>...) |
eb2f2f5f SB |
17 | 'git submodule' [--quiet] update [<options>] [--] [<path>...] |
18 | 'git submodule' [--quiet] summary [<options>] [--] [<path>...] | |
15fc56a8 | 19 | 'git submodule' [--quiet] foreach [--recursive] <command> |
9393ae79 | 20 | 'git submodule' [--quiet] sync [--recursive] [--] [<path>...] |
f6f85861 | 21 | 'git submodule' [--quiet] absorbgitdirs [--] [<path>...] |
70c7ac22 LH |
22 | |
23 | ||
e38953ab PB |
24 | DESCRIPTION |
25 | ----------- | |
ec48a763 | 26 | Inspects, updates and manages submodules. |
c47f1024 | 27 | |
d4803455 | 28 | For more information about submodules, see linkgit:gitsubmodules[7]. |
e38953ab | 29 | |
70c7ac22 LH |
30 | COMMANDS |
31 | -------- | |
68cabbfd DL |
32 | With no arguments, shows the status of existing submodules. Several |
33 | subcommands are available to perform operations on the submodules. | |
34 | ||
eb2f2f5f | 35 | add [-b <branch>] [-f|--force] [--name <name>] [--reference <repository>] [--depth <depth>] [--] <repository> [<path>]:: |
ecda0723 | 36 | Add the given repository as a submodule at the given path |
ec05df35 | 37 | to the changeset to be committed next to the current |
77ef80a8 | 38 | project: the current project is termed the "superproject". |
ec05df35 | 39 | + |
ec05df35 ML |
40 | <repository> is the URL of the new submodule's origin repository. |
41 | This may be either an absolute URL, or (if it begins with ./ | |
d1b3b81a | 42 | or ../), the location relative to the superproject's default remote |
9e6ed475 JL |
43 | repository (Please note that to specify a repository 'foo.git' |
44 | which is located right next to a superproject 'bar.git', you'll | |
68ed71b5 | 45 | have to use `../foo.git` instead of `./foo.git` - as one might expect |
9e6ed475 JL |
46 | when following the rules for relative URLs - because the evaluation |
47 | of relative URLs in Git is identical to that of relative directories). | |
d1b3b81a | 48 | + |
30aa96cd RD |
49 | The default remote is the remote of the remote-tracking branch |
50 | of the current branch. If no such remote-tracking branch exists or | |
d1b3b81a SB |
51 | the HEAD is detached, "origin" is assumed to be the default remote. |
52 | If the superproject doesn't have a default remote configured | |
4d689320 JL |
53 | the superproject is its own authoritative upstream and the current |
54 | working directory is used instead. | |
ec05df35 | 55 | + |
beebc6df KS |
56 | The optional argument <path> is the relative location for the cloned |
57 | submodule to exist in the superproject. If <path> is not given, the | |
58 | canonical part of the source repository is used ("repo" for | |
59 | "/path/to/repo.git" and "foo" for "host.xz:foo/.git"). If <path> | |
60 | exists and is already a valid Git repository, then it is staged | |
61 | for commit without cloning. The <path> is also used as the submodule's | |
62 | logical name in its configuration entries unless `--name` is used | |
63 | to specify a logical name. | |
ec05df35 | 64 | + |
beebc6df KS |
65 | The given URL is recorded into `.gitmodules` for use by subsequent users |
66 | cloning the superproject. If the URL is given relative to the | |
67 | superproject's repository, the presumption is the superproject and | |
68 | submodule repositories will be kept together in the same relative | |
69 | location, and only the superproject's URL needs to be provided. | |
70 | git-submodule will correctly locate the submodule using the relative | |
71 | URL in `.gitmodules`. | |
ecda0723 | 72 | |
eb2f2f5f | 73 | status [--cached] [--recursive] [--] [<path>...]:: |
70c7ac22 LH |
74 | Show the status of the submodules. This will print the SHA-1 of the |
75 | currently checked out commit for each submodule, along with the | |
0b444cdb | 76 | submodule path and the output of 'git describe' for the |
e1b3f3dd KS |
77 | SHA-1. Each SHA-1 will possibly be prefixed with `-` if the submodule is |
78 | not initialized, `+` if the currently checked out submodule commit | |
70c7ac22 | 79 | does not match the SHA-1 found in the index of the containing |
313ee0d6 | 80 | repository and `U` if the submodule has merge conflicts. |
64b19ffe | 81 | + |
402e8a6d | 82 | If `--recursive` is specified, this command will recurse into nested |
64b19ffe | 83 | submodules, and show their status as well. |
402e8a6d JL |
84 | + |
85 | If you are only interested in changes of the currently initialized | |
86 | submodules with respect to the commit recorded in the index or the HEAD, | |
87 | linkgit:git-status[1] and linkgit:git-diff[1] will provide that information | |
88 | too (and can also report changes to a submodule's work tree). | |
70c7ac22 | 89 | |
eb2f2f5f | 90 | init [--] [<path>...]:: |
3244eb9b | 91 | Initialize the submodules recorded in the index (which were |
d1b3b81a | 92 | added and committed elsewhere) by setting `submodule.$name.url` |
beebc6df | 93 | in .git/config. It uses the same setting from `.gitmodules` as |
d1b3b81a SB |
94 | a template. If the URL is relative, it will be resolved using |
95 | the default remote. If there is no default remote, the current | |
96 | repository will be assumed to be upstream. | |
97 | + | |
98 | Optional <path> arguments limit which submodules will be initialized. | |
3e7eaed0 BW |
99 | If no path is specified and submodule.active has been configured, submodules |
100 | configured to be active will be initialized, otherwise all submodules are | |
101 | initialized. | |
d1b3b81a SB |
102 | + |
103 | When present, it will also copy the value of `submodule.$name.update`. | |
104 | This command does not alter existing information in .git/config. | |
105 | You can then customize the submodule clone URLs in .git/config | |
106 | for your local setup and proceed to `git submodule update`; | |
107 | you can also just use `git submodule update --init` without | |
108 | the explicit 'init' step if you do not intend to customize | |
109 | any submodule locations. | |
110 | + | |
64127575 | 111 | See the add subcommand for the definition of default remote. |
70c7ac22 | 112 | |
eb2f2f5f | 113 | deinit [-f|--force] (--all|[--] <path>...):: |
cf419828 JL |
114 | Unregister the given submodules, i.e. remove the whole |
115 | `submodule.$name` section from .git/config together with their work | |
116 | tree. Further calls to `git submodule update`, `git submodule foreach` | |
117 | and `git submodule sync` will skip any unregistered submodules until | |
118 | they are initialized again, so use this command if you don't want to | |
d4803455 | 119 | have a local checkout of the submodule in your working tree anymore. |
cf419828 | 120 | + |
f6a52799 SB |
121 | When the command is run without pathspec, it errors out, |
122 | instead of deinit-ing everything, to prevent mistakes. | |
123 | + | |
124 | If `--force` is specified, the submodule's working tree will | |
125 | be removed even if it contains local modifications. | |
d4803455 SB |
126 | + |
127 | If you really want to remove a submodule from the repository and commit | |
128 | that use linkgit:git-rm[1] instead. See linkgit:gitsubmodules[7] for removal | |
129 | options. | |
cf419828 | 130 | |
eb2f2f5f | 131 | update [--init] [--remote] [-N|--no-fetch] [--[no-]recommend-shallow] [-f|--force] [--checkout|--rebase|--merge] [--reference <repository>] [--depth <depth>] [--recursive] [--jobs <n>] [--] [<path>...]:: |
be4d2c83 | 132 | + |
5c31acfb MS |
133 | -- |
134 | Update the registered submodules to match what the superproject | |
135 | expects by cloning missing submodules and updating the working tree of | |
136 | the submodules. The "updating" can be done in several ways depending | |
137 | on command line options and the value of `submodule.<name>.update` | |
fc01a5d2 | 138 | configuration variable. The command line option takes precedence over |
e1b3f3dd KS |
139 | the configuration variable. If neither is given, a 'checkout' is performed. |
140 | The 'update' procedures supported both from the command line as well as | |
141 | through the `submodule.<name>.update` configuration are: | |
5c31acfb MS |
142 | |
143 | checkout;; the commit recorded in the superproject will be | |
fc01a5d2 | 144 | checked out in the submodule on a detached HEAD. |
5c31acfb MS |
145 | + |
146 | If `--force` is specified, the submodule will be checked out (using | |
e1b3f3dd | 147 | `git checkout --force`), even if the commit specified |
5c31acfb MS |
148 | in the index of the containing repository already matches the commit |
149 | checked out in the submodule. | |
150 | ||
151 | rebase;; the current branch of the submodule will be rebased | |
fc01a5d2 | 152 | onto the commit recorded in the superproject. |
5c31acfb MS |
153 | |
154 | merge;; the commit recorded in the superproject will be merged | |
fc01a5d2 SB |
155 | into the current branch in the submodule. |
156 | ||
e1b3f3dd KS |
157 | The following 'update' procedures are only available via the |
158 | `submodule.<name>.update` configuration variable: | |
5c31acfb MS |
159 | |
160 | custom command;; arbitrary shell command that takes a single | |
161 | argument (the sha1 of the commit recorded in the | |
fc01a5d2 SB |
162 | superproject) is executed. When `submodule.<name>.update` |
163 | is set to '!command', the remainder after the exclamation mark | |
164 | is the custom command. | |
5c31acfb | 165 | |
fc01a5d2 | 166 | none;; the submodule is not updated. |
5c31acfb | 167 | |
be4d2c83 | 168 | If the submodule is not yet initialized, and you just want to use the |
beebc6df | 169 | setting as stored in `.gitmodules`, you can automatically initialize the |
402e8a6d | 170 | submodule with the `--init` option. |
5c31acfb | 171 | |
402e8a6d | 172 | If `--recursive` is specified, this command will recurse into the |
b13fd5c1 | 173 | registered submodules, and update any nested submodules within. |
5c31acfb | 174 | -- |
eb2f2f5f | 175 | summary [--cached|--files] [(-n|--summary-limit) <n>] [commit] [--] [<path>...]:: |
925e7f62 PY |
176 | Show commit summary between the given commit (defaults to HEAD) and |
177 | working tree/index. For a submodule in question, a series of commits | |
178 | in the submodule between the given super project commit and the | |
402e8a6d JL |
179 | index or working tree (switched by `--cached`) are shown. If the option |
180 | `--files` is given, show the series of commits in the submodule between | |
ef92e1a4 | 181 | the index of the super project and the working tree of the submodule |
402e8a6d | 182 | (this option doesn't allow to use the `--cached` option or to provide an |
1c244f6e | 183 | explicit commit). |
402e8a6d JL |
184 | + |
185 | Using the `--submodule=log` option with linkgit:git-diff[1] will provide that | |
186 | information too. | |
70c7ac22 | 187 | |
eb2f2f5f | 188 | foreach [--recursive] <command>:: |
19a31f9c | 189 | Evaluates an arbitrary shell command in each checked out submodule. |
b6f7ac8f PC |
190 | The command has access to the variables $name, $sm_path, $displaypath, |
191 | $sha1 and $toplevel: | |
beebc6df | 192 | $name is the name of the relevant submodule section in `.gitmodules`, |
f0fd0dc5 | 193 | $sm_path is the path of the submodule as recorded in the immediate |
b6f7ac8f PC |
194 | superproject, $displaypath contains the relative path from the |
195 | current working directory to the submodules root directory, | |
196 | $sha1 is the commit as recorded in the immediate | |
f0fd0dc5 PC |
197 | superproject, and $toplevel is the absolute path to the top-level |
198 | of the immediate superproject. | |
199 | Note that to avoid conflicts with '$PATH' on Windows, the '$path' | |
200 | variable is now a deprecated synonym of '$sm_path' variable. | |
19a31f9c | 201 | Any submodules defined in the superproject but not checked out are |
402e8a6d | 202 | ignored by this command. Unless given `--quiet`, foreach prints the name |
19a31f9c | 203 | of each submodule before evaluating the command. |
402e8a6d | 204 | If `--recursive` is given, submodules are traversed recursively (i.e. |
15fc56a8 | 205 | the given shell command is evaluated in nested submodules as well). |
19a31f9c ML |
206 | A non-zero return from the command in any submodule causes |
207 | the processing to terminate. This can be overridden by adding '|| :' | |
208 | to the end of the command. | |
209 | + | |
e91461b3 JK |
210 | As an example, the command below will show the path and currently |
211 | checked out commit for each submodule: | |
212 | + | |
213 | -------------- | |
214 | git submodule foreach 'echo $path `git rev-parse HEAD`' | |
215 | -------------- | |
19a31f9c | 216 | |
eb2f2f5f | 217 | sync [--recursive] [--] [<path>...]:: |
2327f61e | 218 | Synchronizes submodules' remote URL configuration setting |
beebc6df | 219 | to the value specified in `.gitmodules`. It will only affect those |
a7793a74 | 220 | submodules which already have a URL entry in .git/config (that is the |
ccee6086 | 221 | case when they are initialized or freshly added). This is useful when |
2327f61e DA |
222 | submodule URLs change upstream and you need to update your local |
223 | repositories accordingly. | |
224 | + | |
4c57a4f8 MÅ |
225 | `git submodule sync` synchronizes all submodules while |
226 | `git submodule sync -- A` synchronizes submodule "A" only. | |
e7220c40 SB |
227 | + |
228 | If `--recursive` is specified, this command will recurse into the | |
229 | registered submodules, and sync any nested submodules within. | |
19a31f9c | 230 | |
f6f85861 SB |
231 | absorbgitdirs:: |
232 | If a git directory of a submodule is inside the submodule, | |
233 | move the git directory of the submodule into its superprojects | |
234 | `$GIT_DIR/modules` path and then connect the git directory and | |
235 | its working directory by setting the `core.worktree` and adding | |
236 | a .git file pointing to the git directory embedded in the | |
237 | superprojects git directory. | |
238 | + | |
239 | A repository that was cloned independently and later added as a submodule or | |
240 | old setups have the submodules git directory inside the submodule instead of | |
241 | embedded into the superprojects git directory. | |
242 | + | |
243 | This command is recursive by default. | |
244 | ||
70c7ac22 LH |
245 | OPTIONS |
246 | ------- | |
3240240f SB |
247 | -q:: |
248 | --quiet:: | |
70c7ac22 LH |
249 | Only print error messages. |
250 | ||
6d33e1c2 CF |
251 | --progress:: |
252 | This option is only valid for add and update commands. | |
253 | Progress status is reported on the standard error stream | |
254 | by default when it is attached to a terminal, unless -q | |
255 | is specified. This flag forces progress status even if the | |
256 | standard error stream is not directed to a terminal. | |
257 | ||
f6a52799 SB |
258 | --all:: |
259 | This option is only valid for the deinit command. Unregister all | |
260 | submodules in the working tree. | |
261 | ||
3240240f SB |
262 | -b:: |
263 | --branch:: | |
ecda0723 | 264 | Branch of repository to add as submodule. |
15d64936 | 265 | The name of the branch is recorded as `submodule.<name>.branch` in |
15ef7800 BW |
266 | `.gitmodules` for `update --remote`. A special value of `.` is used to |
267 | indicate that the name of the branch in the submodule should be the | |
268 | same name as the current branch in the current repository. | |
ecda0723 | 269 | |
d27b876b JL |
270 | -f:: |
271 | --force:: | |
cf419828 | 272 | This option is only valid for add, deinit and update commands. |
9db31bdf | 273 | When running add, allow adding an otherwise ignored submodule path. |
f6a52799 SB |
274 | When running deinit the submodule working trees will be removed even |
275 | if they contain local changes. | |
5c31acfb MS |
276 | When running update (only effective with the checkout procedure), |
277 | throw away local changes in submodules when switching to a | |
278 | different commit; and always run a checkout operation in the | |
279 | submodule, even if the commit listed in the index of the | |
280 | containing repository matches the commit checked out in the | |
281 | submodule. | |
d27b876b | 282 | |
70c7ac22 | 283 | --cached:: |
925e7f62 PY |
284 | This option is only valid for status and summary commands. These |
285 | commands typically use the commit found in the submodule HEAD, but | |
286 | with this option, the commit stored in the index is used instead. | |
287 | ||
1c244f6e JL |
288 | --files:: |
289 | This option is only valid for the summary command. This command | |
290 | compares the commit in the index with that in the submodule HEAD | |
291 | when this option is used. | |
292 | ||
3240240f SB |
293 | -n:: |
294 | --summary-limit:: | |
925e7f62 PY |
295 | This option is only valid for the summary command. |
296 | Limit the summary size (number of commits shown in total). | |
51836e9e | 297 | Giving 0 will disable the summary; a negative number means unlimited |
925e7f62 PY |
298 | (the default). This limit only applies to modified submodules. The |
299 | size is always limited to 1 for added/deleted/typechanged submodules. | |
70c7ac22 | 300 | |
06b1abb5 TK |
301 | --remote:: |
302 | This option is only valid for the update command. Instead of using | |
303 | the superproject's recorded SHA-1 to update the submodule, use the | |
d6ac1d21 | 304 | status of the submodule's remote-tracking branch. The remote used |
06b1abb5 TK |
305 | is branch's remote (`branch.<name>.remote`), defaulting to `origin`. |
306 | The remote branch used defaults to `master`, but the branch name may | |
307 | be overridden by setting the `submodule.<name>.branch` option in | |
308 | either `.gitmodules` or `.git/config` (with `.git/config` taking | |
309 | precedence). | |
310 | + | |
311 | This works for any of the supported update procedures (`--checkout`, | |
312 | `--rebase`, etc.). The only change is the source of the target SHA-1. | |
313 | For example, `submodule update --remote --merge` will merge upstream | |
314 | submodule changes into the submodules, while `submodule update | |
315 | --merge` will merge superproject gitlink changes into the submodules. | |
316 | + | |
317 | In order to ensure a current tracking branch state, `update --remote` | |
318 | fetches the submodule's remote repository before calculating the | |
319 | SHA-1. If you don't want to fetch, you should use `submodule update | |
320 | --remote --no-fetch`. | |
9937e65d TK |
321 | + |
322 | Use this option to integrate changes from the upstream subproject with | |
323 | your submodule's current HEAD. Alternatively, you can run `git pull` | |
324 | from the submodule, which is equivalent except for the remote branch | |
325 | name: `update --remote` uses the default upstream repository and | |
326 | `submodule.<name>.branch`, while `git pull` uses the submodule's | |
327 | `branch.<name>.merge`. Prefer `submodule.<name>.branch` if you want | |
328 | to distribute the default upstream branch with the superproject and | |
329 | `branch.<name>.merge` if you want a more native feel while working in | |
330 | the submodule itself. | |
06b1abb5 | 331 | |
31ca3ac3 FF |
332 | -N:: |
333 | --no-fetch:: | |
334 | This option is only valid for the update command. | |
335 | Don't fetch new objects from the remote site. | |
336 | ||
893a9764 JL |
337 | --checkout:: |
338 | This option is only valid for the update command. | |
339 | Checkout the commit recorded in the superproject on a detached HEAD | |
340 | in the submodule. This is the default behavior, the main use of | |
341 | this option is to override `submodule.$name.update` when set to | |
5c31acfb | 342 | a value other than `checkout`. |
893a9764 JL |
343 | If the key `submodule.$name.update` is either not explicitly set or |
344 | set to `checkout`, this option is implicit. | |
345 | ||
42b49178 JH |
346 | --merge:: |
347 | This option is only valid for the update command. | |
348 | Merge the commit recorded in the superproject into the current branch | |
349 | of the submodule. If this option is given, the submodule's HEAD will | |
350 | not be detached. If a merge failure prevents this process, you will | |
351 | have to resolve the resulting conflicts within the submodule with the | |
352 | usual conflict resolution tools. | |
353 | If the key `submodule.$name.update` is set to `merge`, this option is | |
354 | implicit. | |
355 | ||
ca2cedba PH |
356 | --rebase:: |
357 | This option is only valid for the update command. | |
358 | Rebase the current branch onto the commit recorded in the | |
359 | superproject. If this option is given, the submodule's HEAD will not | |
6a5d0b0a | 360 | be detached. If a merge failure prevents this process, you will have |
ca2cedba | 361 | to resolve these failures with linkgit:git-rebase[1]. |
32948425 | 362 | If the key `submodule.$name.update` is set to `rebase`, this option is |
ca2cedba PH |
363 | implicit. |
364 | ||
402e8a6d JL |
365 | --init:: |
366 | This option is only valid for the update command. | |
367 | Initialize all submodules for which "git submodule init" has not been | |
368 | called so far before updating. | |
369 | ||
73b0898d JL |
370 | --name:: |
371 | This option is only valid for the add command. It sets the submodule's | |
372 | name to the given string instead of defaulting to its path. The name | |
373 | must be valid as a directory name and may not end with a '/'. | |
374 | ||
d92a3959 MT |
375 | --reference <repository>:: |
376 | This option is only valid for add and update commands. These | |
377 | commands sometimes need to clone a remote repository. In this case, | |
378 | this option will be passed to the linkgit:git-clone[1] command. | |
379 | + | |
380 | *NOTE*: Do *not* use this option unless you have read the note | |
a0ef2934 CF |
381 | for linkgit:git-clone[1]'s `--reference`, `--shared`, and `--dissociate` |
382 | options carefully. | |
383 | ||
384 | --dissociate:: | |
385 | This option is only valid for add and update commands. These | |
386 | commands sometimes need to clone a remote repository. In this case, | |
387 | this option will be passed to the linkgit:git-clone[1] command. | |
388 | + | |
389 | *NOTE*: see the NOTE for the `--reference` option. | |
d92a3959 | 390 | |
15fc56a8 | 391 | --recursive:: |
e7220c40 | 392 | This option is only valid for foreach, update, status and sync commands. |
15fc56a8 JH |
393 | Traverse submodules recursively. The operation is performed not |
394 | only in the submodules of the current repo, but also | |
395 | in any nested submodules inside those submodules (and so on). | |
396 | ||
275cd184 FG |
397 | --depth:: |
398 | This option is valid for add and update commands. Create a 'shallow' | |
399 | clone with a history truncated to the specified number of revisions. | |
400 | See linkgit:git-clone[1] | |
401 | ||
abed000a SB |
402 | --[no-]recommend-shallow:: |
403 | This option is only valid for the update command. | |
404 | The initial clone of a submodule will use the recommended | |
beebc6df | 405 | `submodule.<name>.shallow` as provided by the `.gitmodules` file |
abed000a SB |
406 | by default. To ignore the suggestions use `--no-recommend-shallow`. |
407 | ||
2335b870 SB |
408 | -j <n>:: |
409 | --jobs <n>:: | |
410 | This option is only valid for the update command. | |
411 | Clone new submodules in parallel with as many jobs. | |
412 | Defaults to the `submodule.fetchJobs` option. | |
275cd184 | 413 | |
f448e24e AMS |
414 | <path>...:: |
415 | Paths to submodule(s). When specified this will restrict the command | |
70c7ac22 | 416 | to only operate on the submodules found at the specified paths. |
ec05df35 | 417 | (This argument is required with add). |
70c7ac22 LH |
418 | |
419 | FILES | |
420 | ----- | |
beebc6df | 421 | When initializing submodules, a `.gitmodules` file in the top-level directory |
70c7ac22 | 422 | of the containing repository is used to find the url of each submodule. |
c4585701 | 423 | This file should be formatted in the same way as `$GIT_DIR/config`. The key |
5162e697 | 424 | to each submodule url is "submodule.$name.url". See linkgit:gitmodules[5] |
6fbe42c7 | 425 | for details. |
70c7ac22 | 426 | |
d4803455 SB |
427 | SEE ALSO |
428 | -------- | |
429 | linkgit:gitsubmodules[7], linkgit:gitmodules[5]. | |
430 | ||
70c7ac22 LH |
431 | GIT |
432 | --- | |
9e1f0a85 | 433 | Part of the linkgit:git[1] suite |