submodule: process conflicting submodules only once
[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 103 SHA-1. Each SHA-1 will be prefixed with `-` if the submodule is not
313ee0d6 104 initialized, `+` if the currently checked out submodule commit
70c7ac22 105 does not match the SHA-1 found in the index of the containing
313ee0d6
NMC
106 repository and `U` if the submodule has merge conflicts.
107 This command is the default command for 'git submodule'.
64b19ffe
JH
108+
109If '--recursive' is specified, this command will recurse into nested
110submodules, and show their status as well.
70c7ac22
LH
111
112init::
c47f1024
PB
113 Initialize the submodules, i.e. register each submodule name
114 and url found in .gitmodules into .git/config.
115 The key used in .git/config is `submodule.$name.url`.
116 This command does not alter existing information in .git/config.
117 You can then customize the submodule clone URLs in .git/config
ca768288
TR
118 for your local setup and proceed to `git submodule update`;
119 you can also just use `git submodule update --init` without
c47f1024
PB
120 the explicit 'init' step if you do not intend to customize
121 any submodule locations.
70c7ac22
LH
122
123update::
211b7f19
LH
124 Update the registered submodules, i.e. clone missing submodules and
125 checkout the commit specified in the index of the containing repository.
42b49178
JH
126 This will make the submodules HEAD be detached unless '--rebase' or
127 '--merge' is specified or the key `submodule.$name.update` is set to
128 `rebase` or `merge`.
be4d2c83
JS
129+
130If the submodule is not yet initialized, and you just want to use the
131setting as stored in .gitmodules, you can automatically initialize the
132submodule with the --init option.
b13fd5c1
JH
133+
134If '--recursive' is specified, this command will recurse into the
135registered submodules, and update any nested submodules within.
70c7ac22 136
925e7f62
PY
137summary::
138 Show commit summary between the given commit (defaults to HEAD) and
139 working tree/index. For a submodule in question, a series of commits
140 in the submodule between the given super project commit and the
1c244f6e
JL
141 index or working tree (switched by --cached) are shown. If the option
142 --files is given, show the series of commits in the submodule between
ef92e1a4 143 the index of the super project and the working tree of the submodule
1c244f6e
JL
144 (this option doesn't allow to use the --cached option or to provide an
145 explicit commit).
70c7ac22 146
19a31f9c
ML
147foreach::
148 Evaluates an arbitrary shell command in each checked out submodule.
f030c96d
ÆAB
149 The command has access to the variables $name, $path, $sha1 and
150 $toplevel:
1e7f2aad 151 $name is the name of the relevant submodule section in .gitmodules,
19a31f9c 152 $path is the name of the submodule directory relative to the
f030c96d
ÆAB
153 superproject, $sha1 is the commit as recorded in the superproject,
154 and $toplevel is the absolute path to the top-level of the superproject.
19a31f9c
ML
155 Any submodules defined in the superproject but not checked out are
156 ignored by this command. Unless given --quiet, foreach prints the name
157 of each submodule before evaluating the command.
15fc56a8
JH
158 If --recursive is given, submodules are traversed recursively (i.e.
159 the given shell command is evaluated in nested submodules as well).
19a31f9c
ML
160 A non-zero return from the command in any submodule causes
161 the processing to terminate. This can be overridden by adding '|| :'
162 to the end of the command.
163+
1c3acfcd
MV
164As an example, +git submodule foreach \'echo $path {backtick}git
165rev-parse HEAD{backtick}'+ will show the path and currently checked out
166commit for each submodule.
19a31f9c 167
2327f61e
DA
168sync::
169 Synchronizes submodules' remote URL configuration setting
170 to the value specified in .gitmodules. This is useful when
171 submodule URLs change upstream and you need to update your local
172 repositories accordingly.
173+
174"git submodule sync" synchronizes all submodules while
175"git submodule sync -- A" synchronizes submodule "A" only.
19a31f9c 176
70c7ac22
LH
177OPTIONS
178-------
3240240f
SB
179-q::
180--quiet::
70c7ac22
LH
181 Only print error messages.
182
3240240f
SB
183-b::
184--branch::
ecda0723
SV
185 Branch of repository to add as submodule.
186
d27b876b
JL
187-f::
188--force::
189 This option is only valid for the add command.
190 Allow adding an otherwise ignored submodule path.
191
70c7ac22 192--cached::
925e7f62
PY
193 This option is only valid for status and summary commands. These
194 commands typically use the commit found in the submodule HEAD, but
195 with this option, the commit stored in the index is used instead.
196
1c244f6e
JL
197--files::
198 This option is only valid for the summary command. This command
199 compares the commit in the index with that in the submodule HEAD
200 when this option is used.
201
3240240f
SB
202-n::
203--summary-limit::
925e7f62
PY
204 This option is only valid for the summary command.
205 Limit the summary size (number of commits shown in total).
51836e9e 206 Giving 0 will disable the summary; a negative number means unlimited
925e7f62
PY
207 (the default). This limit only applies to modified submodules. The
208 size is always limited to 1 for added/deleted/typechanged submodules.
70c7ac22 209
31ca3ac3
FF
210-N::
211--no-fetch::
212 This option is only valid for the update command.
213 Don't fetch new objects from the remote site.
214
42b49178
JH
215--merge::
216 This option is only valid for the update command.
217 Merge the commit recorded in the superproject into the current branch
218 of the submodule. If this option is given, the submodule's HEAD will
219 not be detached. If a merge failure prevents this process, you will
220 have to resolve the resulting conflicts within the submodule with the
221 usual conflict resolution tools.
222 If the key `submodule.$name.update` is set to `merge`, this option is
223 implicit.
224
ca2cedba
PH
225--rebase::
226 This option is only valid for the update command.
227 Rebase the current branch onto the commit recorded in the
228 superproject. If this option is given, the submodule's HEAD will not
6a5d0b0a 229 be detached. If a merge failure prevents this process, you will have
ca2cedba 230 to resolve these failures with linkgit:git-rebase[1].
32948425 231 If the key `submodule.$name.update` is set to `rebase`, this option is
ca2cedba
PH
232 implicit.
233
d92a3959
MT
234--reference <repository>::
235 This option is only valid for add and update commands. These
236 commands sometimes need to clone a remote repository. In this case,
237 this option will be passed to the linkgit:git-clone[1] command.
238+
239*NOTE*: Do *not* use this option unless you have read the note
240for linkgit:git-clone[1]'s --reference and --shared options carefully.
241
15fc56a8 242--recursive::
64b19ffe 243 This option is only valid for foreach, update and status commands.
15fc56a8
JH
244 Traverse submodules recursively. The operation is performed not
245 only in the submodules of the current repo, but also
246 in any nested submodules inside those submodules (and so on).
247
f448e24e
AMS
248<path>...::
249 Paths to submodule(s). When specified this will restrict the command
70c7ac22 250 to only operate on the submodules found at the specified paths.
ec05df35 251 (This argument is required with add).
70c7ac22
LH
252
253FILES
254-----
211b7f19 255When initializing submodules, a .gitmodules file in the top-level directory
70c7ac22 256of the containing repository is used to find the url of each submodule.
c4585701 257This file should be formatted in the same way as `$GIT_DIR/config`. The key
5162e697 258to each submodule url is "submodule.$name.url". See linkgit:gitmodules[5]
6fbe42c7 259for details.
70c7ac22
LH
260
261
262AUTHOR
263------
264Written by Lars Hjemli <hjemli@gmail.com>
265
266GIT
267---
9e1f0a85 268Part of the linkgit:git[1] suite