Change "remote tracking" to "remote-tracking"
[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]
681b036f 12'git submodule' [--quiet] add [-b <branch>] [-f|--force] [--name <name>]
1414e578 13 [--reference <repository>] [--] <repository> [<path>]
64b19ffe 14'git submodule' [--quiet] status [--cached] [--recursive] [--] [<path>...]
b1889c36 15'git submodule' [--quiet] init [--] [<path>...]
cf419828 16'git submodule' [--quiet] deinit [-f|--force] [--] <path>...
443d803e
JH
17'git submodule' [--quiet] update [--init] [--remote] [-N|--no-fetch]
18 [-f|--force] [--rebase] [--reference <repository>]
19 [--merge] [--recursive] [--] [<path>...]
402e8a6d
JL
20'git submodule' [--quiet] summary [--cached|--files] [(-n|--summary-limit) <n>]
21 [commit] [--] [<path>...]
15fc56a8 22'git submodule' [--quiet] foreach [--recursive] <command>
2327f61e 23'git submodule' [--quiet] sync [--] [<path>...]
70c7ac22
LH
24
25
e38953ab
PB
26DESCRIPTION
27-----------
c47f1024
PB
28Submodules allow foreign repositories to be embedded within
29a dedicated subdirectory of the source tree, always pointed
30at a particular commit.
31
32They are not to be confused with remotes, which are meant mainly
33for branches of the same project; submodules are meant for
34different projects you would like to make part of your source tree,
35while the history of the two projects still stays completely
36independent and you cannot modify the contents of the submodule
37from within the main project.
38If you want to merge the project histories and want to treat the
39aggregated whole as a single project from then on, you may want to
40add a remote for the other project and use the 'subtree' merge strategy,
41instead of treating the other project as a submodule. Directories
42that come from both projects can be cloned and checked out as a whole
43if you choose to go that route.
44
45Submodules are composed from a so-called `gitlink` tree entry
46in the main repository that refers to a particular commit object
47within the inner repository that is completely separate.
cb2df369
HV
48A record in the `.gitmodules` (see linkgit:gitmodules[5]) file at the
49root of the source tree assigns a logical name to the submodule and
50describes the default URL the submodule shall be cloned from.
c47f1024
PB
51The logical name can be used for overriding this URL within your
52local repository configuration (see 'submodule init').
53
54This command will manage the tree entries and contents of the
55gitmodules file for you, as well as inspect the status of your
56submodules and update them.
57When adding a new submodule to the tree, the 'add' subcommand
58is to be used. However, when pulling a tree containing submodules,
59these will not be checked out by default;
60the 'init' and 'update' subcommands will maintain submodules
61checked out and at appropriate revision in your working tree.
62You can briefly inspect the up-to-date status of your submodules
63using the 'status' subcommand and get a detailed overview of the
64difference between the index and checkouts using the 'summary'
65subcommand.
e38953ab
PB
66
67
70c7ac22
LH
68COMMANDS
69--------
ecda0723
SV
70add::
71 Add the given repository as a submodule at the given path
ec05df35 72 to the changeset to be committed next to the current
77ef80a8 73 project: the current project is termed the "superproject".
ec05df35 74+
1414e578
JL
75This requires at least one argument: <repository>. The optional
76argument <path> is the relative location for the cloned submodule
77to exist in the superproject. If <path> is not given, the
78"humanish" part of the source repository is used ("repo" for
79"/path/to/repo.git" and "foo" for "host.xz:foo/.git").
3244eb9b
DW
80The <path> is also used as the submodule's logical name in its
81configuration entries unless `--name` is used to specify a logical name.
ec05df35
ML
82+
83<repository> is the URL of the new submodule's origin repository.
84This may be either an absolute URL, or (if it begins with ./
85or ../), the location relative to the superproject's origin
9e6ed475
JL
86repository (Please note that to specify a repository 'foo.git'
87which is located right next to a superproject 'bar.git', you'll
88have to use '../foo.git' instead of './foo.git' - as one might expect
89when following the rules for relative URLs - because the evaluation
90of relative URLs in Git is identical to that of relative directories).
91If the superproject doesn't have an origin configured
4d689320
JL
92the superproject is its own authoritative upstream and the current
93working directory is used instead.
ec05df35
ML
94+
95<path> is the relative location for the cloned submodule to
96exist in the superproject. If <path> does not exist, then the
97submodule is created by cloning from the named URL. If <path> does
2de9b711 98exist and is already a valid Git repository, then this is added
ec05df35
ML
99to the changeset without cloning. This second form is provided
100to ease creating a new submodule from scratch, and presumes
101the user will later push the submodule to the given URL.
102+
103In either case, the given URL is recorded into .gitmodules for
104use by subsequent users cloning the superproject. If the URL is
105given relative to the superproject's repository, the presumption
106is the superproject and submodule repositories will be kept
107together in the same relative location, and only the
04c8ce9c 108superproject's URL needs to be provided: git-submodule will correctly
ec05df35 109locate the submodule using the relative URL in .gitmodules.
ecda0723 110
70c7ac22
LH
111status::
112 Show the status of the submodules. This will print the SHA-1 of the
113 currently checked out commit for each submodule, along with the
0b444cdb 114 submodule path and the output of 'git describe' for the
70c7ac22 115 SHA-1. Each SHA-1 will be prefixed with `-` if the submodule is not
313ee0d6 116 initialized, `+` if the currently checked out submodule commit
70c7ac22 117 does not match the SHA-1 found in the index of the containing
313ee0d6 118 repository and `U` if the submodule has merge conflicts.
64b19ffe 119+
402e8a6d 120If `--recursive` is specified, this command will recurse into nested
64b19ffe 121submodules, and show their status as well.
402e8a6d
JL
122+
123If you are only interested in changes of the currently initialized
124submodules with respect to the commit recorded in the index or the HEAD,
125linkgit:git-status[1] and linkgit:git-diff[1] will provide that information
126too (and can also report changes to a submodule's work tree).
70c7ac22
LH
127
128init::
3244eb9b
DW
129 Initialize the submodules recorded in the index (which were
130 added and committed elsewhere) by copying submodule
131 names and urls from .gitmodules to .git/config.
132 Optional <path> arguments limit which submodules will be initialized.
322bb6e1
HV
133 It will also copy the value of `submodule.$name.update` into
134 .git/config.
c47f1024
PB
135 The key used in .git/config is `submodule.$name.url`.
136 This command does not alter existing information in .git/config.
137 You can then customize the submodule clone URLs in .git/config
ca768288
TR
138 for your local setup and proceed to `git submodule update`;
139 you can also just use `git submodule update --init` without
c47f1024
PB
140 the explicit 'init' step if you do not intend to customize
141 any submodule locations.
70c7ac22 142
cf419828
JL
143deinit::
144 Unregister the given submodules, i.e. remove the whole
145 `submodule.$name` section from .git/config together with their work
146 tree. Further calls to `git submodule update`, `git submodule foreach`
147 and `git submodule sync` will skip any unregistered submodules until
148 they are initialized again, so use this command if you don't want to
149 have a local checkout of the submodule in your work tree anymore. If
150 you really want to remove a submodule from the repository and commit
151 that use linkgit:git-rm[1] instead.
152+
153If `--force` is specified, the submodule's work tree will be removed even if
154it contains local modifications.
155
70c7ac22 156update::
211b7f19
LH
157 Update the registered submodules, i.e. clone missing submodules and
158 checkout the commit specified in the index of the containing repository.
402e8a6d
JL
159 This will make the submodules HEAD be detached unless `--rebase` or
160 `--merge` is specified or the key `submodule.$name.update` is set to
8d8136c3 161 `rebase`, `merge` or `none`. `none` can be overridden by specifying
e6a1c43a 162 `--checkout`.
be4d2c83
JS
163+
164If the submodule is not yet initialized, and you just want to use the
165setting as stored in .gitmodules, you can automatically initialize the
402e8a6d 166submodule with the `--init` option.
b13fd5c1 167+
402e8a6d 168If `--recursive` is specified, this command will recurse into the
b13fd5c1 169registered submodules, and update any nested submodules within.
01d47215
SZ
170+
171If `--force` is specified, the submodule will be checked out (using
172`git checkout --force` if appropriate), even if the commit specified in the
173index of the containing repository already matches the commit checked out in
174the submodule.
70c7ac22 175
925e7f62
PY
176summary::
177 Show commit summary between the given commit (defaults to HEAD) and
178 working tree/index. For a submodule in question, a series of commits
179 in the submodule between the given super project commit and the
402e8a6d
JL
180 index or working tree (switched by `--cached`) are shown. If the option
181 `--files` is given, show the series of commits in the submodule between
ef92e1a4 182 the index of the super project and the working tree of the submodule
402e8a6d 183 (this option doesn't allow to use the `--cached` option or to provide an
1c244f6e 184 explicit commit).
402e8a6d
JL
185+
186Using the `--submodule=log` option with linkgit:git-diff[1] will provide that
187information too.
70c7ac22 188
19a31f9c
ML
189foreach::
190 Evaluates an arbitrary shell command in each checked out submodule.
f030c96d
ÆAB
191 The command has access to the variables $name, $path, $sha1 and
192 $toplevel:
1e7f2aad 193 $name is the name of the relevant submodule section in .gitmodules,
19a31f9c 194 $path is the name of the submodule directory relative to the
f030c96d
ÆAB
195 superproject, $sha1 is the commit as recorded in the superproject,
196 and $toplevel is the absolute path to the top-level of the superproject.
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+
1c3acfcd
MV
206As an example, +git submodule foreach \'echo $path {backtick}git
207rev-parse HEAD{backtick}'+ will show the path and currently checked out
208commit for each submodule.
19a31f9c 209
2327f61e
DA
210sync::
211 Synchronizes submodules' remote URL configuration setting
ccee6086 212 to the value specified in .gitmodules. It will only affect those
a7793a74 213 submodules which already have a URL entry in .git/config (that is the
ccee6086 214 case when they are initialized or freshly added). This is useful when
2327f61e
DA
215 submodule URLs change upstream and you need to update your local
216 repositories accordingly.
217+
218"git submodule sync" synchronizes all submodules while
565e135a 219"git submodule sync \-- A" synchronizes submodule "A" only.
19a31f9c 220
70c7ac22
LH
221OPTIONS
222-------
3240240f
SB
223-q::
224--quiet::
70c7ac22
LH
225 Only print error messages.
226
3240240f
SB
227-b::
228--branch::
ecda0723 229 Branch of repository to add as submodule.
b9289227
TK
230 The name of the branch is recorded as `submodule.<path>.branch` in
231 `.gitmodules` for `update --remote`.
ecda0723 232
d27b876b
JL
233-f::
234--force::
cf419828 235 This option is only valid for add, deinit and update commands.
9db31bdf 236 When running add, allow adding an otherwise ignored submodule path.
cf419828
JL
237 When running deinit the submodule work trees will be removed even if
238 they contain local changes.
9db31bdf 239 When running update, throw away local changes in submodules when
01d47215
SZ
240 switching to a different commit; and always run a checkout operation
241 in the submodule, even if the commit listed in the index of the
242 containing repository matches the commit checked out in the submodule.
d27b876b 243
70c7ac22 244--cached::
925e7f62
PY
245 This option is only valid for status and summary commands. These
246 commands typically use the commit found in the submodule HEAD, but
247 with this option, the commit stored in the index is used instead.
248
1c244f6e
JL
249--files::
250 This option is only valid for the summary command. This command
251 compares the commit in the index with that in the submodule HEAD
252 when this option is used.
253
3240240f
SB
254-n::
255--summary-limit::
925e7f62
PY
256 This option is only valid for the summary command.
257 Limit the summary size (number of commits shown in total).
51836e9e 258 Giving 0 will disable the summary; a negative number means unlimited
925e7f62
PY
259 (the default). This limit only applies to modified submodules. The
260 size is always limited to 1 for added/deleted/typechanged submodules.
70c7ac22 261
06b1abb5
TK
262--remote::
263 This option is only valid for the update command. Instead of using
264 the superproject's recorded SHA-1 to update the submodule, use the
d6ac1d21 265 status of the submodule's remote-tracking branch. The remote used
06b1abb5
TK
266 is branch's remote (`branch.<name>.remote`), defaulting to `origin`.
267 The remote branch used defaults to `master`, but the branch name may
268 be overridden by setting the `submodule.<name>.branch` option in
269 either `.gitmodules` or `.git/config` (with `.git/config` taking
270 precedence).
271+
272This works for any of the supported update procedures (`--checkout`,
273`--rebase`, etc.). The only change is the source of the target SHA-1.
274For example, `submodule update --remote --merge` will merge upstream
275submodule changes into the submodules, while `submodule update
276--merge` will merge superproject gitlink changes into the submodules.
277+
278In order to ensure a current tracking branch state, `update --remote`
279fetches the submodule's remote repository before calculating the
280SHA-1. If you don't want to fetch, you should use `submodule update
281--remote --no-fetch`.
282
31ca3ac3
FF
283-N::
284--no-fetch::
285 This option is only valid for the update command.
286 Don't fetch new objects from the remote site.
287
42b49178
JH
288--merge::
289 This option is only valid for the update command.
290 Merge the commit recorded in the superproject into the current branch
291 of the submodule. If this option is given, the submodule's HEAD will
292 not be detached. If a merge failure prevents this process, you will
293 have to resolve the resulting conflicts within the submodule with the
294 usual conflict resolution tools.
295 If the key `submodule.$name.update` is set to `merge`, this option is
296 implicit.
297
ca2cedba
PH
298--rebase::
299 This option is only valid for the update command.
300 Rebase the current branch onto the commit recorded in the
301 superproject. If this option is given, the submodule's HEAD will not
6a5d0b0a 302 be detached. If a merge failure prevents this process, you will have
ca2cedba 303 to resolve these failures with linkgit:git-rebase[1].
32948425 304 If the key `submodule.$name.update` is set to `rebase`, this option is
ca2cedba
PH
305 implicit.
306
402e8a6d
JL
307--init::
308 This option is only valid for the update command.
309 Initialize all submodules for which "git submodule init" has not been
310 called so far before updating.
311
73b0898d
JL
312--name::
313 This option is only valid for the add command. It sets the submodule's
314 name to the given string instead of defaulting to its path. The name
315 must be valid as a directory name and may not end with a '/'.
316
d92a3959
MT
317--reference <repository>::
318 This option is only valid for add and update commands. These
319 commands sometimes need to clone a remote repository. In this case,
320 this option will be passed to the linkgit:git-clone[1] command.
321+
322*NOTE*: Do *not* use this option unless you have read the note
402e8a6d 323for linkgit:git-clone[1]'s `--reference` and `--shared` options carefully.
d92a3959 324
15fc56a8 325--recursive::
64b19ffe 326 This option is only valid for foreach, update and status commands.
15fc56a8
JH
327 Traverse submodules recursively. The operation is performed not
328 only in the submodules of the current repo, but also
329 in any nested submodules inside those submodules (and so on).
330
f448e24e
AMS
331<path>...::
332 Paths to submodule(s). When specified this will restrict the command
70c7ac22 333 to only operate on the submodules found at the specified paths.
ec05df35 334 (This argument is required with add).
70c7ac22
LH
335
336FILES
337-----
211b7f19 338When initializing submodules, a .gitmodules file in the top-level directory
70c7ac22 339of the containing repository is used to find the url of each submodule.
c4585701 340This file should be formatted in the same way as `$GIT_DIR/config`. The key
5162e697 341to each submodule url is "submodule.$name.url". See linkgit:gitmodules[5]
6fbe42c7 342for details.
70c7ac22 343
70c7ac22
LH
344GIT
345---
9e1f0a85 346Part of the linkgit:git[1] suite