freshlybakedca.ke
Git fork
1git-submodule(1)
2================
3
4NAME
5----
6git-submodule - Initialize, update or inspect submodules
7
8
9SYNOPSIS
10--------
11[verse]
12'git submodule' [--quiet] [--cached]
13'git submodule' [--quiet] add [<options>] [--] <repository> [<path>]
14'git submodule' [--quiet] status [--cached] [--recursive] [--] [<path>...]
15'git submodule' [--quiet] init [--] [<path>...]
16'git submodule' [--quiet] deinit [-f|--force] (--all|[--] <path>...)
17'git submodule' [--quiet] update [<options>] [--] [<path>...]
18'git submodule' [--quiet] set-branch [<options>] [--] <path>
19'git submodule' [--quiet] set-url [--] <path> <newurl>
20'git submodule' [--quiet] summary [<options>] [--] [<path>...]
21'git submodule' [--quiet] foreach [--recursive] <command>
22'git submodule' [--quiet] sync [--recursive] [--] [<path>...]
23'git submodule' [--quiet] absorbgitdirs [--] [<path>...]
24
25
26DESCRIPTION
27-----------
28Inspects, updates and manages submodules.
29
30For more information about submodules, see linkgit:gitsubmodules[7].
31
32COMMANDS
33--------
34With no arguments, shows the status of existing submodules. Several
35subcommands are available to perform operations on the submodules.
36
37add [-b <branch>] [-f|--force] [--name <name>] [--reference <repository>] [--ref-format <format>] [--depth <depth>] [--] <repository> [<path>]::
38 Add the given repository as a submodule at the given path
39 to the changeset to be committed next to the current
40 project: the current project is termed the "superproject".
41+
42<repository> is the URL of the new submodule's origin repository.
43This may be either an absolute URL, or (if it begins with ./
44or ../), the location relative to the superproject's default remote
45repository (Please note that to specify a repository 'foo.git'
46which is located right next to a superproject 'bar.git', you'll
47have to use `../foo.git` instead of `./foo.git` - as one might expect
48when following the rules for relative URLs - because the evaluation
49of relative URLs in Git is identical to that of relative directories).
50+
51The default remote is the remote of the remote-tracking branch
52of the current branch. If no such remote-tracking branch exists or
53the HEAD is detached, "origin" is assumed to be the default remote.
54If the superproject doesn't have a default remote configured
55the superproject is its own authoritative upstream and the current
56working directory is used instead.
57+
58The optional argument <path> is the relative location for the cloned
59submodule to exist in the superproject. If <path> is not given, the
60canonical part of the source repository is used ("repo" for
61"/path/to/repo.git" and "foo" for "host.xz:foo/.git"). If <path>
62exists and is already a valid Git repository, then it is staged
63for commit without cloning. The <path> is also used as the submodule's
64logical name in its configuration entries unless `--name` is used
65to specify a logical name.
66+
67The given URL is recorded into `.gitmodules` for use by subsequent users
68cloning the superproject. If the URL is given relative to the
69superproject's repository, the presumption is the superproject and
70submodule repositories will be kept together in the same relative
71location, and only the superproject's URL needs to be provided.
72git-submodule will correctly locate the submodule using the relative
73URL in `.gitmodules`.
74+
75If `--ref-format <format>` is specified, the ref storage format of newly
76cloned submodules will be set accordingly.
77
78status [--cached] [--recursive] [--] [<path>...]::
79 Show the status of the submodules. This will print the SHA-1 of the
80 currently checked out commit for each submodule, along with the
81 submodule path and the output of 'git describe' for the
82 SHA-1. Each SHA-1 will possibly be prefixed with `-` if the submodule is
83 not initialized, `+` if the currently checked out submodule commit
84 does not match the SHA-1 found in the index of the containing
85 repository and `U` if the submodule has merge conflicts.
86+
87If `--cached` is specified, this command will instead print the SHA-1
88recorded in the superproject for each submodule.
89+
90If `--recursive` is specified, this command will recurse into nested
91submodules, and show their status as well.
92+
93If you are only interested in changes of the currently initialized
94submodules with respect to the commit recorded in the index or the HEAD,
95linkgit:git-status[1] and linkgit:git-diff[1] will provide that information
96too (and can also report changes to a submodule's work tree).
97
98init [--] [<path>...]::
99 Initialize the submodules recorded in the index (which were
100 added and committed elsewhere) by setting `submodule.$name.url`
101 in `.git/config`, using the same setting from `.gitmodules` as
102 a template. If the URL is relative, it will be resolved using
103 the default remote. If there is no default remote, the current
104 repository will be assumed to be upstream.
105+
106Optional <path> arguments limit which submodules will be initialized.
107If no path is specified and submodule.active has been configured, submodules
108configured to be active will be initialized, otherwise all submodules are
109initialized.
110+
111It will also copy the value of `submodule.$name.update`, if present in
112the `.gitmodules` file, to `.git/config`, but (1) this command does not
113alter existing information in `.git/config`, and (2) `submodule.$name.update`
114that is set to a custom command is *not* copied for security reasons.
115+
116You can then customize the submodule clone URLs in `.git/config`
117for your local setup and proceed to `git submodule update`;
118you can also just use `git submodule update --init` without
119the explicit 'init' step if you do not intend to customize
120any submodule locations.
121+
122See the add subcommand for the definition of default remote.
123
124deinit [-f|--force] (--all|[--] <path>...)::
125 Unregister the given submodules, i.e. remove the whole
126 `submodule.$name` section from .git/config together with their work
127 tree. Further calls to `git submodule update`, `git submodule foreach`
128 and `git submodule sync` will skip any unregistered submodules until
129 they are initialized again, so use this command if you don't want to
130 have a local checkout of the submodule in your working tree anymore.
131+
132When the command is run without pathspec, it errors out,
133instead of deinit-ing everything, to prevent mistakes.
134+
135If `--force` is specified, the submodule's working tree will
136be removed even if it contains local modifications.
137+
138If you really want to remove a submodule from the repository and commit
139that use linkgit:git-rm[1] instead. See linkgit:gitsubmodules[7] for removal
140options.
141
142update [--init] [--remote] [-N|--no-fetch] [--[no-]recommend-shallow] [-f|--force] [--checkout|--rebase|--merge] [--reference <repository>] [--ref-format <format>] [--depth <depth>] [--recursive] [--jobs <n>] [--[no-]single-branch] [--filter <filter-spec>] [--] [<path>...]::
143+
144--
145Update the registered submodules to match what the superproject
146expects by cloning missing submodules, fetching missing commits
147in submodules and updating the working tree of
148the submodules. The "updating" can be done in several ways depending
149on command line options and the value of `submodule.<name>.update`
150configuration variable. The command line option takes precedence over
151the configuration variable. If neither is given, a 'checkout' is performed.
152(note: what is in `.gitmodules` file is irrelevant at this point;
153see `git submodule init` above for how `.gitmodules` is used).
154The 'update' procedures supported both from the command line as well as
155through the `submodule.<name>.update` configuration are:
156
157 checkout;; the commit recorded in the superproject will be
158 checked out in the submodule on a detached HEAD.
159+
160If `--force` is specified, the submodule will be checked out (using
161`git checkout --force`), even if the commit specified
162in the index of the containing repository already matches the commit
163checked out in the submodule.
164
165 rebase;; the current branch of the submodule will be rebased
166 onto the commit recorded in the superproject.
167
168 merge;; the commit recorded in the superproject will be merged
169 into the current branch in the submodule.
170
171The following update procedures have additional limitations:
172
173 custom command;; mechanism for running arbitrary commands with the
174 commit ID as an argument. Specifically, if the
175 `submodule.<name>.update` configuration variable is set to
176 `!custom command`, the object name of the commit recorded in the
177 superproject for the submodule is appended to the `custom command`
178 string and executed. Note that this mechanism is not supported in
179 the `.gitmodules` file or on the command line.
180
181 none;; the submodule is not updated. This update procedure is not
182 allowed on the command line.
183
184If the submodule is not yet initialized, and you just want to use the
185setting as stored in `.gitmodules`, you can automatically initialize the
186submodule with the `--init` option.
187
188If `--recursive` is specified, this command will recurse into the
189registered submodules, and update any nested submodules within.
190
191If `--ref-format <format>` is specified, the ref storage format of newly
192cloned submodules will be set accordingly.
193
194If `--filter <filter-spec>` is specified, the given partial clone filter will be
195applied to the submodule. See linkgit:git-rev-list[1] for details on filter
196specifications.
197--
198set-branch (-b|--branch) <branch> [--] <path>::
199set-branch (-d|--default) [--] <path>::
200 Sets the default remote tracking branch for the submodule. The
201 `--branch` option allows the remote branch to be specified. The
202 `--default` option removes the submodule.<name>.branch configuration
203 key, which causes the tracking branch to default to the remote 'HEAD'.
204
205set-url [--] <path> <newurl>::
206 Sets the URL of the specified submodule to <newurl>. Then, it will
207 automatically synchronize the submodule's new remote URL
208 configuration.
209
210summary [--cached|--files] [(-n|--summary-limit) <n>] [commit] [--] [<path>...]::
211 Show commit summary between the given commit (defaults to HEAD) and
212 working tree/index. For a submodule in question, a series of commits
213 in the submodule between the given super project commit and the
214 index or working tree (switched by `--cached`) are shown. If the option
215 `--files` is given, show the series of commits in the submodule between
216 the index of the super project and the working tree of the submodule
217 (this option doesn't allow to use the `--cached` option or to provide an
218 explicit commit).
219+
220Using the `--submodule=log` option with linkgit:git-diff[1] will provide that
221information too.
222
223foreach [--recursive] <command>::
224 Evaluates an arbitrary shell command in each checked out submodule.
225 The command has access to the variables $name, $sm_path, $displaypath,
226 $sha1 and $toplevel:
227 $name is the name of the relevant submodule section in `.gitmodules`,
228 $sm_path is the path of the submodule as recorded in the immediate
229 superproject, $displaypath contains the relative path from the
230 current working directory to the submodules root directory,
231 $sha1 is the commit as recorded in the immediate
232 superproject, and $toplevel is the absolute path to the top-level
233 of the immediate superproject.
234 Note that to avoid conflicts with '$PATH' on Windows, the '$path'
235 variable is now a deprecated synonym of '$sm_path' variable.
236 Any submodules defined in the superproject but not checked out are
237 ignored by this command. Unless given `--quiet`, foreach prints the name
238 of each submodule before evaluating the command.
239 If `--recursive` is given, submodules are traversed recursively (i.e.
240 the given shell command is evaluated in nested submodules as well).
241 A non-zero return from the command in any submodule causes
242 the processing to terminate. This can be overridden by adding '|| :'
243 to the end of the command.
244+
245As an example, the command below will show the path and currently
246checked out commit for each submodule:
247+
248--------------
249git submodule foreach 'echo $sm_path `git rev-parse HEAD`'
250--------------
251
252sync [--recursive] [--] [<path>...]::
253 Synchronizes submodules' remote URL configuration setting
254 to the value specified in `.gitmodules`. It will only affect those
255 submodules which already have a URL entry in .git/config (that is the
256 case when they are initialized or freshly added). This is useful when
257 submodule URLs change upstream and you need to update your local
258 repositories accordingly.
259+
260`git submodule sync` synchronizes all submodules while
261`git submodule sync -- A` synchronizes submodule "A" only.
262+
263If `--recursive` is specified, this command will recurse into the
264registered submodules, and sync any nested submodules within.
265
266absorbgitdirs::
267 If a git directory of a submodule is inside the submodule,
268 move the git directory of the submodule into its superproject's
269 `$GIT_DIR/modules` path and then connect the git directory and
270 its working directory by setting the `core.worktree` and adding
271 a .git file pointing to the git directory embedded in the
272 superprojects git directory.
273+
274A repository that was cloned independently and later added as a submodule or
275old setups have the submodules git directory inside the submodule instead of
276embedded into the superprojects git directory.
277+
278This command is recursive by default.
279
280OPTIONS
281-------
282-q::
283--quiet::
284 Only print error messages.
285
286--progress::
287 This option is only valid for add and update commands.
288 Progress status is reported on the standard error stream
289 by default when it is attached to a terminal, unless -q
290 is specified. This flag forces progress status even if the
291 standard error stream is not directed to a terminal.
292
293--all::
294 This option is only valid for the deinit command. Unregister all
295 submodules in the working tree.
296
297-b <branch>::
298--branch <branch>::
299 Branch of repository to add as submodule.
300 The name of the branch is recorded as `submodule.<name>.branch` in
301 `.gitmodules` for `update --remote`. A special value of `.` is used to
302 indicate that the name of the branch in the submodule should be the
303 same name as the current branch in the current repository. If the
304 option is not specified, it defaults to the remote 'HEAD'.
305
306-f::
307--force::
308 This option is only valid for add, deinit and update commands.
309 When running add, allow adding an otherwise ignored submodule path.
310 This option is also used to bypass a check that the submodule's name
311 is not already in use. By default, 'git submodule add' will fail if
312 the proposed name (which is derived from the path) is already registered
313 for another submodule in the repository. Using '--force' allows the command
314 to proceed by automatically generating a unique name by appending a number
315 to the conflicting name (e.g., if a submodule named 'child' exists, it will
316 try 'child1', and so on).
317 When running deinit the submodule working trees will be removed even
318 if they contain local changes.
319 When running update (only effective with the checkout procedure),
320 throw away local changes in submodules when switching to a
321 different commit; and always run a checkout operation in the
322 submodule, even if the commit listed in the index of the
323 containing repository matches the commit checked out in the
324 submodule.
325
326--cached::
327 This option is only valid for status and summary commands. These
328 commands typically use the commit found in the submodule HEAD, but
329 with this option, the commit stored in the index is used instead.
330
331--files::
332 This option is only valid for the summary command. This command
333 compares the commit in the index with that in the submodule HEAD
334 when this option is used.
335
336-n::
337--summary-limit::
338 This option is only valid for the summary command.
339 Limit the summary size (number of commits shown in total).
340 Giving 0 will disable the summary; a negative number means unlimited
341 (the default). This limit only applies to modified submodules. The
342 size is always limited to 1 for added/deleted/typechanged submodules.
343
344--remote::
345 This option is only valid for the update command. Instead of using
346 the superproject's recorded SHA-1 to update the submodule, use the
347 status of the submodule's remote-tracking branch. The remote used
348 is branch's remote (`branch.<name>.remote`), defaulting to `origin`.
349 The remote branch used defaults to the remote `HEAD`, but the branch
350 name may be overridden by setting the `submodule.<name>.branch`
351 option in either `.gitmodules` or `.git/config` (with `.git/config`
352 taking precedence).
353+
354This works for any of the supported update procedures (`--checkout`,
355`--rebase`, etc.). The only change is the source of the target SHA-1.
356For example, `submodule update --remote --merge` will merge upstream
357submodule changes into the submodules, while `submodule update
358--merge` will merge superproject gitlink changes into the submodules.
359+
360In order to ensure a current tracking branch state, `update --remote`
361fetches the submodule's remote repository before calculating the
362SHA-1. If you don't want to fetch, you should use `submodule update
363--remote --no-fetch`.
364+
365Use this option to integrate changes from the upstream subproject with
366your submodule's current HEAD. Alternatively, you can run `git pull`
367from the submodule, which is equivalent except for the remote branch
368name: `update --remote` uses the default upstream repository and
369`submodule.<name>.branch`, while `git pull` uses the submodule's
370`branch.<name>.merge`. Prefer `submodule.<name>.branch` if you want
371to distribute the default upstream branch with the superproject and
372`branch.<name>.merge` if you want a more native feel while working in
373the submodule itself.
374
375-N::
376--no-fetch::
377 This option is only valid for the update command.
378 Don't fetch new objects from the remote site.
379
380--checkout::
381 This option is only valid for the update command.
382 Checkout the commit recorded in the superproject on a detached HEAD
383 in the submodule. This is the default behavior, the main use of
384 this option is to override `submodule.$name.update` when set to
385 a value other than `checkout`.
386 If the key `submodule.$name.update` is either not explicitly set or
387 set to `checkout`, this option is implicit.
388
389--merge::
390 This option is only valid for the update command.
391 Merge the commit recorded in the superproject into the current branch
392 of the submodule. If this option is given, the submodule's HEAD will
393 not be detached. If a merge failure prevents this process, you will
394 have to resolve the resulting conflicts within the submodule with the
395 usual conflict resolution tools.
396 If the key `submodule.$name.update` is set to `merge`, this option is
397 implicit.
398
399--rebase::
400 This option is only valid for the update command.
401 Rebase the current branch onto the commit recorded in the
402 superproject. If this option is given, the submodule's HEAD will not
403 be detached. If a merge failure prevents this process, you will have
404 to resolve these failures with linkgit:git-rebase[1].
405 If the key `submodule.$name.update` is set to `rebase`, this option is
406 implicit.
407
408--init::
409 This option is only valid for the update command.
410 Initialize all submodules for which "git submodule init" has not been
411 called so far before updating.
412
413--name::
414 This option is only valid for the add command. It sets the submodule's
415 name to the given string instead of defaulting to its path. The name
416 must be valid as a directory name and may not end with a '/'.
417
418--reference <repository>::
419 This option is only valid for add and update commands. These
420 commands sometimes need to clone a remote repository. In this case,
421 this option will be passed to the linkgit:git-clone[1] command.
422+
423*NOTE*: Do *not* use this option unless you have read the note
424for linkgit:git-clone[1]'s `--reference`, `--shared`, and `--dissociate`
425options carefully.
426
427--dissociate::
428 This option is only valid for add and update commands. These
429 commands sometimes need to clone a remote repository. In this case,
430 this option will be passed to the linkgit:git-clone[1] command.
431+
432*NOTE*: see the NOTE for the `--reference` option.
433
434--recursive::
435 This option is only valid for foreach, update, status and sync commands.
436 Traverse submodules recursively. The operation is performed not
437 only in the submodules of the current repo, but also
438 in any nested submodules inside those submodules (and so on).
439
440--depth::
441 This option is valid for add and update commands. Create a 'shallow'
442 clone with a history truncated to the specified number of revisions.
443 See linkgit:git-clone[1]
444
445--recommend-shallow::
446--no-recommend-shallow::
447 This option is only valid for the update command.
448 The initial clone of a submodule will use the recommended
449 `submodule.<name>.shallow` as provided by the `.gitmodules` file
450 by default. To ignore the suggestions use `--no-recommend-shallow`.
451
452-j <n>::
453--jobs <n>::
454 This option is only valid for the update command.
455 Clone new submodules in parallel with as many jobs.
456 Defaults to the `submodule.fetchJobs` option.
457
458--single-branch::
459--no-single-branch::
460 This option is only valid for the update command.
461 Clone only one branch during update: HEAD or one specified by --branch.
462
463<path>...::
464 Paths to submodule(s). When specified this will restrict the command
465 to only operate on the submodules found at the specified paths.
466 (This argument is required with add).
467
468FILES
469-----
470When initializing submodules, a `.gitmodules` file in the top-level directory
471of the containing repository is used to find the url of each submodule.
472This file should be formatted in the same way as `$GIT_DIR/config`. The key
473to each submodule url is "submodule.$name.url". See linkgit:gitmodules[5]
474for details.
475
476SEE ALSO
477--------
478linkgit:gitsubmodules[7], linkgit:gitmodules[5].
479
480GIT
481---
482Part of the linkgit:git[1] suite