Skip to content

Commit a328b2c

Browse files
committed
Merge branch 'sb/clone-recursive-submodule-doc'
Doc update. * sb/clone-recursive-submodule-doc: Documentation/git-clone: improve description for submodule recursing
2 parents e7d1b52 + bc29b0b commit a328b2c

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

Documentation/git-clone.txt

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ SYNOPSIS
1414
[-o <name>] [-b <name>] [-u <upload-pack>] [--reference <repository>]
1515
[--dissociate] [--separate-git-dir <git dir>]
1616
[--depth <depth>] [--[no-]single-branch] [--no-tags]
17-
[--recurse-submodules] [--[no-]shallow-submodules]
17+
[--recurse-submodules[=<pathspec>]] [--[no-]shallow-submodules]
1818
[--jobs <n>] [--] <repository> [<directory>]
1919

2020
DESCRIPTION
@@ -231,14 +231,17 @@ branch of some repository for search indexing.
231231
After the clone is created, initialize and clone submodules
232232
within based on the provided pathspec. If no pathspec is
233233
provided, all submodules are initialized and cloned.
234-
Submodules are initialized and cloned using their default
235-
settings. The resulting clone has `submodule.active` set to
234+
This option can be given multiple times for pathspecs consisting
235+
of multiple entries. The resulting clone has `submodule.active` set to
236236
the provided pathspec, or "." (meaning all submodules) if no
237-
pathspec is provided. This is equivalent to running
238-
`git submodule update --init --recursive` immediately after
239-
the clone is finished. This option is ignored if the cloned
240-
repository does not have a worktree/checkout (i.e. if any of
241-
`--no-checkout`/`-n`, `--bare`, or `--mirror` is given)
237+
pathspec is provided.
238+
+
239+
Submodules are initialized and cloned using their default settings. This is
240+
equivalent to running
241+
`git submodule update --init --recursive <pathspec>` immediately after
242+
the clone is finished. This option is ignored if the cloned repository does
243+
not have a worktree/checkout (i.e. if any of `--no-checkout`/`-n`, `--bare`,
244+
or `--mirror` is given)
242245

243246
--[no-]shallow-submodules::
244247
All submodules which are cloned will be shallow with a depth of 1.

0 commit comments

Comments
 (0)