submodule sync: do not auto-vivify uninteresting submodule
[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]
d27b876b 12'git submodule' [--quiet] add [-b branch] [-f|--force]
1414e578 13 [--reference <repository>] [--] <repository> [<path>]
64b19ffe 14'git submodule' [--quiet] status [--cached] [--recursive] [--] [<path>...]
b1889c36 15'git submodule' [--quiet] init [--] [<path>...]
7d40f891 16'git submodule' [--quiet] update [--init] [-N|--no-fetch] [--rebase]
b13fd5c1 17 [--reference <repository>] [--merge] [--recursive] [--] [<path>...]
1c244f6e 18'git submodule' [--quiet] summary [--cached|--files] [--summary-limit <n>] [commit] [--] [<path>...]
15fc56a8 19'git submodule' [--quiet] foreach [--recursive] <command>
2327f61e 20'git submodule' [--quiet] sync [--] [<path>...]
70c7ac22
LH
21
22
e38953ab
PB
23DESCRIPTION
24-----------
c47f1024
PB
25Submodules allow foreign repositories to be embedded within
26a dedicated subdirectory of the source tree, always pointed
27at a particular commit.
28
29They are not to be confused with remotes, which are meant mainly
30for branches of the same project; submodules are meant for
31different projects you would like to make part of your source tree,
32while the history of the two projects still stays completely
33independent and you cannot modify the contents of the submodule
34from within the main project.
35If you want to merge the project histories and want to treat the
36aggregated whole as a single project from then on, you may want to
37add a remote for the other project and use the 'subtree' merge strategy,
38instead of treating the other project as a submodule. Directories
39that come from both projects can be cloned and checked out as a whole
40if you choose to go that route.
41
42Submodules are composed from a so-called `gitlink` tree entry
43in the main repository that refers to a particular commit object
44within the inner repository that is completely separate.
45A record in the `.gitmodules` file at the root of the source
46tree assigns a logical name to the submodule and describes
47the default URL the submodule shall be cloned from.
48The logical name can be used for overriding this URL within your
49local repository configuration (see 'submodule init').
50
51This command will manage the tree entries and contents of the
52gitmodules file for you, as well as inspect the status of your
53submodules and update them.
54When adding a new submodule to the tree, the 'add' subcommand
55is to be used. However, when pulling a tree containing submodules,
56these will not be checked out by default;
57the 'init' and 'update' subcommands will maintain submodules
58checked out and at appropriate revision in your working tree.
59You can briefly inspect the up-to-date status of your submodules
60using the 'status' subcommand and get a detailed overview of the
61difference between the index and checkouts using the 'summary'
62subcommand.
e38953ab
PB
63
64
70c7ac22
LH
65COMMANDS
66--------
ecda0723
SV
67add::
68 Add the given repository as a submodule at the given path
ec05df35 69 to the changeset to be committed next to the current
77ef80a8 70 project: the current project is termed the "superproject".
ec05df35 71+
1414e578
JL
72This requires at least one argument: <repository>. The optional
73argument <path> is the relative location for the cloned submodule
74to exist in the superproject. If <path> is not given, the
75"humanish" part of the source repository is used ("repo" for
76"/path/to/repo.git" and "foo" for "host.xz:foo/.git").
ec05df35
ML
77+
78<repository> is the URL of the new submodule's origin repository.
79This may be either an absolute URL, or (if it begins with ./
80or ../), the location relative to the superproject's origin
81repository.
82+
83<path> is the relative location for the cloned submodule to
84exist in the superproject. If <path> does not exist, then the
85submodule is created by cloning from the named URL. If <path> does
86exist and is already a valid git repository, then this is added
87to the changeset without cloning. This second form is provided
88to ease creating a new submodule from scratch, and presumes
89the user will later push the submodule to the given URL.
90+
91In either case, the given URL is recorded into .gitmodules for
92use by subsequent users cloning the superproject. If the URL is
93given relative to the superproject's repository, the presumption
94is the superproject and submodule repositories will be kept
95together in the same relative location, and only the
04c8ce9c 96superproject's URL needs to be provided: git-submodule will correctly
ec05df35 97locate the submodule using the relative URL in .gitmodules.
ecda0723 98
70c7ac22
LH
99status::
100 Show the status of the submodules. This will print the SHA-1 of the
101 currently checked out commit for each submodule, along with the
0b444cdb 102 submodule path and the output of 'git describe' for the
70c7ac22
LH
103 SHA-1. Each SHA-1 will be prefixed with `-` if the submodule is not
104 initialized and `+` if the currently checked out submodule commit
105 does not match the SHA-1 found in the index of the containing
0b444cdb 106 repository. This command is the default command for 'git submodule'.
64b19ffe
JH
107+
108If '--recursive' is specified, this command will recurse into nested
109submodules, and show their status as well.
70c7ac22
LH
110
111init::
c47f1024
PB
112 Initialize the submodules, i.e. register each submodule name
113 and url found in .gitmodules into .git/config.
114 The key used in .git/config is `submodule.$name.url`.
115 This command does not alter existing information in .git/config.
116 You can then customize the submodule clone URLs in .git/config
ca768288
TR
117 for your local setup and proceed to `git submodule update`;
118 you can also just use `git submodule update --init` without
c47f1024
PB
119 the explicit 'init' step if you do not intend to customize
120 any submodule locations.
70c7ac22
LH
121
122update::
211b7f19
LH
123 Update the registered submodules, i.e. clone missing submodules and
124 checkout the commit specified in the index of the containing repository.
42b49178
JH
125 This will make the submodules HEAD be detached unless '--rebase' or
126 '--merge' is specified or the key `submodule.$name.update` is set to
127 `rebase` or `merge`.
be4d2c83
JS
128+
129If the submodule is not yet initialized, and you just want to use the
130setting as stored in .gitmodules, you can automatically initialize the
131submodule with the --init option.
b13fd5c1
JH
132+
133If '--recursive' is specified, this command will recurse into the
134registered submodules, and update any nested submodules within.
70c7ac22 135
925e7f62
PY
136summary::
137 Show commit summary between the given commit (defaults to HEAD) and
138 working tree/index. For a submodule in question, a series of commits
139 in the submodule between the given super project commit and the
1c244f6e
JL
140 index or working tree (switched by --cached) are shown. If the option
141 --files is given, show the series of commits in the submodule between
ef92e1a4 142 the index of the super project and the working tree of the submodule
1c244f6e
JL
143 (this option doesn't allow to use the --cached option or to provide an
144 explicit commit).
70c7ac22 145
19a31f9c
ML
146foreach::
147 Evaluates an arbitrary shell command in each checked out submodule.
f030c96d
ÆAB
148 The command has access to the variables $name, $path, $sha1 and
149 $toplevel:
1e7f2aad 150 $name is the name of the relevant submodule section in .gitmodules,
19a31f9c 151 $path is the name of the submodule directory relative to the
f030c96d
ÆAB
152 superproject, $sha1 is the commit as recorded in the superproject,
153 and $toplevel is the absolute path to the top-level of the superproject.
19a31f9c
ML
154 Any submodules defined in the superproject but not checked out are
155 ignored by this command. Unless given --quiet, foreach prints the name
156 of each submodule before evaluating the command.
15fc56a8
JH
157 If --recursive is given, submodules are traversed recursively (i.e.
158 the given shell command is evaluated in nested submodules as well).
19a31f9c
ML
159 A non-zero return from the command in any submodule causes
160 the processing to terminate. This can be overridden by adding '|| :'
161 to the end of the command.
162+
1c3acfcd
MV
163As an example, +git submodule foreach \'echo $path {backtick}git
164rev-parse HEAD{backtick}'+ will show the path and currently checked out
165commit for each submodule.
19a31f9c 166
2327f61e
DA
167sync::
168 Synchronizes submodules' remote URL configuration setting
ccee6086
JH
169 to the value specified in .gitmodules. It will only affect those
170 submodules which already have an url entry in .git/config (that is the
171 case when they are initialized or freshly added). This is useful when
2327f61e
DA
172 submodule URLs change upstream and you need to update your local
173 repositories accordingly.
174+
175"git submodule sync" synchronizes all submodules while
176"git submodule sync -- A" synchronizes submodule "A" only.
19a31f9c 177
70c7ac22
LH
178OPTIONS
179-------
3240240f
SB
180-q::
181--quiet::
70c7ac22
LH
182 Only print error messages.
183
3240240f
SB
184-b::
185--branch::
ecda0723
SV
186 Branch of repository to add as submodule.
187
d27b876b
JL
188-f::
189--force::
190 This option is only valid for the add command.
191 Allow adding an otherwise ignored submodule path.
192
70c7ac22 193--cached::
925e7f62
PY
194 This option is only valid for status and summary commands. These
195 commands typically use the commit found in the submodule HEAD, but
196 with this option, the commit stored in the index is used instead.
197
1c244f6e
JL
198--files::
199 This option is only valid for the summary command. This command
200 compares the commit in the index with that in the submodule HEAD
201 when this option is used.
202
3240240f
SB
203-n::
204--summary-limit::
925e7f62
PY
205 This option is only valid for the summary command.
206 Limit the summary size (number of commits shown in total).
51836e9e 207 Giving 0 will disable the summary; a negative number means unlimited
925e7f62
PY
208 (the default). This limit only applies to modified submodules. The
209 size is always limited to 1 for added/deleted/typechanged submodules.
70c7ac22 210
31ca3ac3
FF
211-N::
212--no-fetch::
213 This option is only valid for the update command.
214 Don't fetch new objects from the remote site.
215
42b49178
JH
216--merge::
217 This option is only valid for the update command.
218 Merge the commit recorded in the superproject into the current branch
219 of the submodule. If this option is given, the submodule's HEAD will
220 not be detached. If a merge failure prevents this process, you will
221 have to resolve the resulting conflicts within the submodule with the
222 usual conflict resolution tools.
223 If the key `submodule.$name.update` is set to `merge`, this option is
224 implicit.
225
ca2cedba
PH
226--rebase::
227 This option is only valid for the update command.
228 Rebase the current branch onto the commit recorded in the
229 superproject. If this option is given, the submodule's HEAD will not
6a5d0b0a 230 be detached. If a merge failure prevents this process, you will have
ca2cedba 231 to resolve these failures with linkgit:git-rebase[1].
32948425 232 If the key `submodule.$name.update` is set to `rebase`, this option is
ca2cedba
PH
233 implicit.
234
d92a3959
MT
235--reference <repository>::
236 This option is only valid for add and update commands. These
237 commands sometimes need to clone a remote repository. In this case,
238 this option will be passed to the linkgit:git-clone[1] command.
239+
240*NOTE*: Do *not* use this option unless you have read the note
241for linkgit:git-clone[1]'s --reference and --shared options carefully.
242
15fc56a8 243--recursive::
64b19ffe 244 This option is only valid for foreach, update and status commands.
15fc56a8
JH
245 Traverse submodules recursively. The operation is performed not
246 only in the submodules of the current repo, but also
247 in any nested submodules inside those submodules (and so on).
248
f448e24e
AMS
249<path>...::
250 Paths to submodule(s). When specified this will restrict the command
70c7ac22 251 to only operate on the submodules found at the specified paths.
ec05df35 252 (This argument is required with add).
70c7ac22
LH
253
254FILES
255-----
211b7f19 256When initializing submodules, a .gitmodules file in the top-level directory
70c7ac22 257of the containing repository is used to find the url of each submodule.
c4585701 258This file should be formatted in the same way as `$GIT_DIR/config`. The key
5162e697 259to each submodule url is "submodule.$name.url". See linkgit:gitmodules[5]
6fbe42c7 260for details.
70c7ac22
LH
261
262
263AUTHOR
264------
265Written by Lars Hjemli <hjemli@gmail.com>
266
267GIT
268---
9e1f0a85 269Part of the linkgit:git[1] suite