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