doc: convert git-submodule to synopsis style
* convert commands to synopsis style * use _<placeholder>_ for arguments * convert inline lists into proper definition lists * minor formatting fixes Reviewed-by: Kristoffer Haugsbakk <kristofferhaugsbakk@fastmail.com> Signed-off-by: Jean-Noël Avila <jn.avila@free.fr> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Jean-Noël Avila committed
Feb 6, 2026 at 04:12 UTC
777f5d089c1ab2478f652d706460e1c0c710f5c4
1 file changed
+199
-196
Documentation/git-submodule.adoc
+199
-196
@@ -8,19 +8,19 @@ git-submodule - Initialize, update or inspect submodules
8
9
SYNOPSIS
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>...]
11
+[synopsis]
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
26
DESCRIPTION
@@ -34,34 +34,34 @@ COMMANDS
34
With no arguments, shows the status of existing submodules. Several
35
subcommands are available to perform operations on the submodules.
36
37
-add [-b <branch>] [-f|--force] [--name <name>] [--reference <repository>] [--ref-format <format>] [--depth <depth>] [--] <repository> [<path>]::
37
+`add [-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.
43
-This may be either an absolute URL, or (if it begins with ./
44
-or ../), the location relative to the superproject's default remote
45
-repository (Please note that to specify a repository 'foo.git'
46
-which is located right next to a superproject 'bar.git', you'll
42
+_<repository>_ is the URL of the new submodule's `origin` repository.
43
+This may be either an absolute URL, or (if it begins with `./`
44
+or `../`), the location relative to the superproject's default remote
45
+repository (Please note that to specify a repository `foo.git`
46
+which is located right next to a superproject `bar.git`, you'll
47
have to use `../foo.git` instead of `./foo.git` - as one might expect
48
when following the rules for relative URLs - because the evaluation
49
of relative URLs in Git is identical to that of relative directories).
50
+
51
The default remote is the remote of the remote-tracking branch
52
of the current branch. If no such remote-tracking branch exists or
53
-the HEAD is detached, "origin" is assumed to be the default remote.
53
+the `HEAD` is detached, `origin` is assumed to be the default remote.
54
If the superproject doesn't have a default remote configured
55
the superproject is its own authoritative upstream and the current
56
working directory is used instead.
57
+
58
-The optional argument <path> is the relative location for the cloned
59
-submodule to exist in the superproject. If <path> is not given, the
60
-canonical part of the source repository is used ("repo" for
61
-"/path/to/repo.git" and "foo" for "host.xz:foo/.git"). If <path>
58
+The optional argument _<path>_ is the relative location for the cloned
59
+submodule to exist in the superproject. If _<path>_ is not given, the
60
+canonical part of the source repository is used (`repo` for
61
+`/path/to/repo.git` and `foo` for `host.xz:foo/.git`). If _<path>_
62
exists and is already a valid Git repository, then it is staged
63
-for commit without cloning. The <path> is also used as the submodule's
64
-logical name in its configuration entries unless `--name` is used
63
+for commit without cloning. The _<path>_ is also used as the submodule's
64
+logical name in its configuration entries unless `--name <name>` is used
65
to specify a logical name.
66
+
67
The given URL is recorded into `.gitmodules` for use by subsequent users
@@ -75,10 +75,10 @@ URL in `.gitmodules`.
75
If `--ref-format <format>` is specified, the ref storage format of newly
76
cloned submodules will be set accordingly.
77
78
-status [--cached] [--recursive] [--] [<path>...]::
78
+`status [--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
81
+ submodule path and the output of linkgit:git-describe[1] 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
@@ -91,11 +91,11 @@ If `--recursive` is specified, this command will recurse into nested
91
submodules, and show their status as well.
92
+
93
If you are only interested in changes of the currently initialized
94
-submodules with respect to the commit recorded in the index or the HEAD,
94
+submodules with respect to the commit recorded in the index or the `HEAD`,
95
linkgit:git-status[1] and linkgit:git-diff[1] will provide that information
96
too (and can also report changes to a submodule's work tree).
97
98
-init [--] [<path>...]::
98
+`init [--] [<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
@@ -103,7 +103,7 @@ init [--] [<path>...]::
103
the default remote. If there is no default remote, the current
104
repository will be assumed to be upstream.
105
+
106
-Optional <path> arguments limit which submodules will be initialized.
106
+Optional _<path>_ arguments limit which submodules will be initialized.
107
If no path is specified and submodule.active has been configured, submodules
108
configured to be active will be initialized, otherwise all submodules are
109
initialized.
@@ -116,12 +116,12 @@ that is set to a custom command is *not* copied for security reasons.
116
You can then customize the submodule clone URLs in `.git/config`
117
for your local setup and proceed to `git submodule update`;
118
you can also just use `git submodule update --init` without
119
-the explicit 'init' step if you do not intend to customize
119
+the explicit `init` step if you do not intend to customize
120
any submodule locations.
121
+
122
See the add subcommand for the definition of default remote.
123
124
-deinit [-f|--force] (--all|[--] <path>...)::
124
+`deinit [-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`
@@ -139,7 +139,7 @@ If you really want to remove a submodule from the repository and commit
139
that use linkgit:git-rm[1] instead. See linkgit:gitsubmodules[7] for removal
140
options.
141
142
-update [--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>...]::
142
+`update [--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
--
145
Update the registered submodules to match what the superproject
@@ -148,38 +148,38 @@ in submodules and updating the working tree of
148
the submodules. The "updating" can be done in several ways depending
149
on command line options and the value of `submodule.<name>.update`
150
configuration variable. The command line option takes precedence over
151
-the configuration variable. If neither is given, a 'checkout' is performed.
151
+the configuration variable. If neither is given, a `checkout` is performed.
152
(note: what is in `.gitmodules` file is irrelevant at this point;
153
see `git submodule init` above for how `.gitmodules` is used).
154
-The 'update' procedures supported both from the command line as well as
154
+The `update` procedures supported both from the command line as well as
155
through 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.
157
+`checkout`;; the commit recorded in the superproject will be
158
+checked out in the submodule on a detached `HEAD`.
159
+
160
If `--force` is specified, the submodule will be checked out (using
161
`git checkout --force`), even if the commit specified
162
in the index of the containing repository already matches the commit
163
checked out in the submodule.
164
165
- rebase;; the current branch of the submodule will be rebased
166
- onto the commit recorded in the superproject.
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.
168
+`merge`;; the commit recorded in the superproject will be merged
169
+into the current branch in the submodule.
170
171
The 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.
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.
181
+`none`;; the submodule is not updated. This update procedure is not
182
+allowed on the command line.
183
184
If the submodule is not yet initialized, and you just want to use the
185
setting as stored in `.gitmodules`, you can automatically initialize the
@@ -195,20 +195,20 @@ If `--filter <filter-spec>` is specified, the given partial clone filter will be
195
applied to the submodule. See linkgit:git-rev-list[1] for details on filter
196
specifications.
197
--
198
-set-branch (-b|--branch) <branch> [--] <path>::
199
-set-branch (-d|--default) [--] <path>::
200
- Sets the default remote tracking branch for the submodule. The
198
+`set-branch (-b|--branch) <branch> [--] <path>`::
199
+`set-branch (-d|--default) [--] <path>`::
200
+ Set 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'.
202
+ `--default` option removes the `submodule.<name>.branch` configuration
203
+ key, which causes the tracking branch to default to the remote `HEAD`.
204
205
-set-url [--] <path> <newurl>::
206
- Sets the URL of the specified submodule to <newurl>. Then, it will
205
+`set-url [--] <path> <newurl>`::
206
+ Set the URL of the specified submodule to _<newurl>_. Then, it will
207
automatically synchronize the submodule's new remote URL
208
configuration.
209
210
-summary [--cached|--files] [(-n|--summary-limit) <n>] [commit] [--] [<path>...]::
211
- Show commit summary between the given commit (defaults to HEAD) and
210
+`summary [--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
@@ -220,27 +220,31 @@ summary [--cached|--files] [(-n|--summary-limit) <n>] [commit] [--] [<path>...]:
220
Using the `--submodule=log` option with linkgit:git-diff[1] will provide that
221
information too.
222
223
-foreach [--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.
223
+`foreach [--recursive] <command>`::
224
+ Evaluate 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
++
228
+--
229
+`$name`;; the name of the relevant submodule section in `.gitmodules`
230
+`$sm_path`;; the path of the submodule as recorded in the immediate
231
+ superproject
232
+`$displaypath`;; the relative path from the
233
+ current working directory to the submodules root directory
234
+`$sha1`;; the commit as recorded in the immediate superproject
235
+`$toplevel`;; the absolute path to the top-level of the immediate superproject.
236
+--
237
++
238
+Note that to avoid conflicts with `$PATH` on Windows, the `$path`
239
+variable is now a deprecated synonym of `$sm_path` variable.
240
+Any submodules defined in the superproject but not checked out are
241
+ignored by this command. Unless given `--quiet`, foreach prints the name
242
+of each submodule before evaluating the command.
243
+If `--recursive` is given, submodules are traversed recursively (i.e.
244
+the given shell command is evaluated in nested submodules as well).
245
+A non-zero return from the command in any submodule causes
246
+the processing to terminate. This can be overridden by adding ++||:++
247
+to the end of the command.
248
+
249
As an example, the command below will show the path and currently
250
checked out commit for each submodule:
@@ -249,26 +253,26 @@ checked out commit for each submodule:
253
git submodule foreach 'echo $sm_path `git rev-parse HEAD`'
254
--------------
255
252
-sync [--recursive] [--] [<path>...]::
253
- Synchronizes submodules' remote URL configuration setting
256
+`sync [--recursive] [--] [<path>...]`::
257
+ Synchronize submodules' remote URL configuration setting
258
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
259
+ submodules which already have a URL entry in `.git/config` (that is the
260
case when they are initialized or freshly added). This is useful when
261
submodule URLs change upstream and you need to update your local
262
repositories accordingly.
263
+
264
`git submodule sync` synchronizes all submodules while
261
-`git submodule sync -- A` synchronizes submodule "A" only.
265
+`git submodule sync -- A` synchronizes submodule `A` only.
266
+
267
If `--recursive` is specified, this command will recurse into the
268
registered submodules, and sync any nested submodules within.
269
266
-absorbgitdirs::
270
+`absorbgitdirs`::
271
If a git directory of a submodule is inside the submodule,
272
move the git directory of the submodule into its superproject's
273
`$GIT_DIR/modules` path and then connect the git directory and
274
its working directory by setting the `core.worktree` and adding
271
- a .git file pointing to the git directory embedded in the
275
+ a `.git` file pointing to the git directory embedded in the
276
superprojects git directory.
277
+
278
A repository that was cloned independently and later added as a submodule or
@@ -279,72 +283,70 @@ This command is recursive by default.
283
284
OPTIONS
285
-------
282
--q::
283
---quiet::
286
+`-q`::
287
+`--quiet`::
288
Only print error messages.
289
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
+`--progress`::
291
+ Report progress status on the standard error stream
292
+ by default when it is attached to a terminal, unless `-q`
293
is specified. This flag forces progress status even if the
291
- standard error stream is not directed to a terminal.
294
+ standard error stream is not directed to a terminal. It is
295
+ only valid for `add` and `update` commands.
296
293
---all::
294
- This option is only valid for the deinit command. Unregister all
295
- submodules in the working tree.
297
+`--all`::
298
+ Unregister all submodules in the working tree. This option is only
299
+ valid for the `deinit` command.
300
297
--b <branch>::
298
---branch <branch>::
301
+`-b<branch>`::
302
+`--branch=<branch>`::
303
Branch of repository to add as submodule.
304
The name of the branch is recorded as `submodule.<name>.branch` in
305
`.gitmodules` for `update --remote`. A special value of `.` is used to
306
indicate that the name of the branch in the submodule should be the
307
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).
308
+ option is not specified, it defaults to the remote `HEAD`.
309
+
310
+`-f`::
311
+`--force`::
312
+ Force the command to proceed, even if it would otherwise fail.
313
+ This option is only valid for `add`, `deinit` and `update` commands.
314
+`add`;; allow adding an otherwise ignored submodule path.
315
+This option is also used to bypass a check that the submodule's name
316
+is not already in use. By default, `git submodule add` will fail if
317
+the proposed name (which is derived from the path) is already registered
318
+for another submodule in the repository. Using `--force` allows the command
319
+to proceed by automatically generating a unique name by appending a number
320
+to the conflicting name (e.g., if a submodule named 'child' exists, it will
321
+try 'child1', and so on).
322
+`deinit`;; the submodule working trees will be removed even
323
+if they contain local changes.
324
+`update`;; (only effective with the checkout procedure),
325
+throw away local changes in submodules when switching to a
326
+different commit; and always run a checkout operation in the
327
+submodule, even if the commit listed in the index of the
328
+containing repository matches the commit checked out in the
329
+submodule.
330
+
331
+`--cached`::
332
+ Use the index to determine the commit instead of the `HEAD`.
333
+ This option is only valid for `status` and `summary` commands.
334
+
335
+`--files`::
336
+ Make the `summary` command compare the commit in the index with that in
337
+ the submodule `HEAD`.
338
+
339
+`-n<n>`::
340
+`--summary-limit=<n>`::
341
+ Limit the `summary` size (number of commits shown in total) to _<n>_.
342
Giving 0 will disable the summary; a negative number means unlimited
343
(the default). This limit only applies to modified submodules. The
344
size is always limited to 1 for added/deleted/typechanged submodules.
345
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
346
+`--remote`::
347
+ Instead of using the superproject's recorded SHA-1 to update the
348
+ submodule, use the status of the submodule's remote-tracking branch.
349
+ This option is only valid for the `update` command. The remote used
350
is branch's remote (`branch.<name>.remote`), defaulting to `origin`.
351
The remote branch used defaults to the remote `HEAD`, but the branch
352
name may be overridden by setting the `submodule.<name>.branch`
@@ -363,7 +365,7 @@ SHA-1. If you don't want to fetch, you should use `submodule update
365
--remote --no-fetch`.
366
+
367
Use this option to integrate changes from the upstream subproject with
366
-your submodule's current HEAD. Alternatively, you can run `git pull`
368
+your submodule's current `HEAD`. Alternatively, you can run `git pull`
369
from the submodule, which is equivalent except for the remote branch
370
name: `update --remote` uses the default upstream repository and
371
`submodule.<name>.branch`, while `git pull` uses the submodule's
@@ -372,105 +374,106 @@ to distribute the default upstream branch with the superproject and
374
`branch.<name>.merge` if you want a more native feel while working in
375
the submodule itself.
376
375
--N::
376
---no-fetch::
377
- This option is only valid for the update command.
377
+`-N`::
378
+`--no-fetch`::
379
Don't fetch new objects from the remote site.
380
+ This option is only valid for the `update` command.
381
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
382
+`--checkout`::
383
+ Checkout the commit recorded in the superproject on a detached `HEAD`
384
+ in the submodule. This option is only valid for the `update` command.
385
+ This is the default behavior, the main use of
386
+ this option is to override `submodule.<name>.update` when set to
387
a value other than `checkout`.
386
- If the key `submodule.$name.update` is either not explicitly set or
388
+ If the key `submodule.<name>.update` is either not explicitly set or
389
set to `checkout`, this option is implicit.
390
389
---merge::
390
- This option is only valid for the update command.
391
+`--merge`::
392
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
+ of the submodule. This option is only valid for the `update` command.
394
+ If this option is given, the submodule's `HEAD` will
395
not be detached. If a merge failure prevents this process, you will
396
have to resolve the resulting conflicts within the submodule with the
397
usual conflict resolution tools.
396
- If the key `submodule.$name.update` is set to `merge`, this option is
398
+ If the key `submodule.<name>.update` is set to `merge`, this option is
399
implicit.
400
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
401
+`--rebase`::
402
+ Rebase the current branch onto the commit recorded in the superproject.
403
+ This option is only valid for the `update` command. The submodule's `HEAD` will not
404
be detached. If a merge failure prevents this process, you will have
405
to resolve these failures with linkgit:git-rebase[1].
405
- If the key `submodule.$name.update` is set to `rebase`, this option is
406
+ If the key `submodule.<name>.update` is set to `rebase`, this option is
407
implicit.
408
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.
409
+`--init`::
410
+ Initialize all submodules for which `git submodule init` has not been
411
+ called so far before updating. This option is only valid for the `update`
412
+ command.
413
+
414
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 '/'.
415
+`--name=<name>`::
416
+ Set the submodule's name to the given string instead of defaulting to its path. _<name>_
417
+ must be valid as a directory name and may not end with a `/`.
418
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,
419
+`--reference=<repository>`::
420
+ Pass the local _<repository>_ as a reference when cloning the submodule.
421
+ This option is only valid for `add` and `update` commands.
422
+ These commands sometimes need to clone a remote repository. In this case,
423
this option will be passed to the linkgit:git-clone[1] command.
424
+
423
-*NOTE*: Do *not* use this option unless you have read the note
425
+NOTE: Do *not* use this option unless you have read the note
426
for linkgit:git-clone[1]'s `--reference`, `--shared`, and `--dissociate`
427
options carefully.
428
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,
429
+`--dissociate`::
430
+ After using a reference repository to clone from, do not rely on it anymore.
431
+ This option is only valid for `add` and `update` commands.
432
+ These commands sometimes need to clone a remote repository. In this case,
433
this option will be passed to the linkgit:git-clone[1] command.
434
+
432
-*NOTE*: see the NOTE for the `--reference` option.
435
+NOTE: See the NOTE above for the `--reference` option.
436
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
+`--recursive`::
438
+ Traverse submodules recursively. This option is only valid for `foreach`,
439
+ `update`, `status` and `sync` commands. The operation is performed not
440
only in the submodules of the current repo, but also
441
in any nested submodules inside those submodules (and so on).
442
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]
443
+`--depth=<depth>`::
444
+ Create a 'shallow' clone with a history truncated to the _<depth>_ revisions.
445
+ This option is valid for `add` and `update` commands. See linkgit:git-clone[1]
446
445
---recommend-shallow::
446
---no-recommend-shallow::
447
- This option is only valid for the update command.
447
+`--recommend-shallow`::
448
+`--no-recommend-shallow`::
449
+ Recommend or not shallow cloning of submodules.
450
+ This option is only valid for the `update` command.
451
The initial clone of a submodule will use the recommended
452
`submodule.<name>.shallow` as provided by the `.gitmodules` file
453
by default. To ignore the suggestions use `--no-recommend-shallow`.
454
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.
455
+`-j<n>`::
456
+`--jobs=<n>`::
457
+ Clone new submodules in parallel with _<n>_ jobs.
458
+ This option is only valid for the `update` command.
459
Defaults to the `submodule.fetchJobs` option.
460
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.
461
+`--single-branch`::
462
+`--no-single-branch`::
463
+ Clone only one branch during update: `HEAD` or one specified by `--branch`.
464
+ This option is only valid for the `update` command.
465
463
-<path>...::
466
+`<path>...`::
467
Paths to submodule(s). When specified this will restrict the command
468
to only operate on the submodules found at the specified paths.
466
- (This argument is required with add).
469
+ (This argument is required with `add`).
470
471
FILES
472
-----
473
When initializing submodules, a `.gitmodules` file in the top-level directory
471
-of the containing repository is used to find the url of each submodule.
474
+of the containing repository is used to find the URL of each submodule.
475
This file should be formatted in the same way as `$GIT_DIR/config`. The key
473
-to each submodule url is "submodule.$name.url". See linkgit:gitmodules[5]
476
+to each submodule URL is `submodule.<name>.url`. See linkgit:gitmodules[5]
477
for details.
478
479
SEE ALSO