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