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