diff options
| author | Junio C Hamano <gitster@pobox.com> | 2017-12-19 11:33:56 -0800 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2017-12-19 11:33:56 -0800 |
| commit | a328b2cb63c39b9df9bdc08d27ee29d80fcd768c (patch) | |
| tree | b32bfb8ea045b39101e7880289dd3b279e6a29d1 | |
| parent | e7d1b526d18fcbfb7a003ce971f8ce45827e495e (diff) | |
| parent | bc29b0b9710322ea966a685903e4334a61931fc5 (diff) | |
| download | git-a328b2cb63c39b9df9bdc08d27ee29d80fcd768c.tar.gz | |
Merge branch 'sb/clone-recursive-submodule-doc'
Doc update.
* sb/clone-recursive-submodule-doc:
Documentation/git-clone: improve description for submodule recursing
| -rw-r--r-- | Documentation/git-clone.txt | 19 |
1 files changed, 11 insertions, 8 deletions
diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt index 83c8e9b394..42ca7b5095 100644 --- a/Documentation/git-clone.txt +++ b/Documentation/git-clone.txt @@ -14,7 +14,7 @@ SYNOPSIS [-o <name>] [-b <name>] [-u <upload-pack>] [--reference <repository>] [--dissociate] [--separate-git-dir <git dir>] [--depth <depth>] [--[no-]single-branch] [--no-tags] - [--recurse-submodules] [--[no-]shallow-submodules] + [--recurse-submodules[=<pathspec>]] [--[no-]shallow-submodules] [--jobs <n>] [--] <repository> [<directory>] DESCRIPTION @@ -231,14 +231,17 @@ branch of some repository for search indexing. After the clone is created, initialize and clone submodules within based on the provided pathspec. If no pathspec is provided, all submodules are initialized and cloned. - Submodules are initialized and cloned using their default - settings. The resulting clone has `submodule.active` set to + This option can be given multiple times for pathspecs consisting + of multiple entries. The resulting clone has `submodule.active` set to the provided pathspec, or "." (meaning all submodules) if no - pathspec is provided. This is equivalent to running - `git submodule update --init --recursive` immediately after - the clone is finished. This option is ignored if the cloned - repository does not have a worktree/checkout (i.e. if any of - `--no-checkout`/`-n`, `--bare`, or `--mirror` is given) + pathspec is provided. ++ +Submodules are initialized and cloned using their default settings. This is +equivalent to running +`git submodule update --init --recursive <pathspec>` immediately after +the clone is finished. This option is ignored if the cloned repository does +not have a worktree/checkout (i.e. if any of `--no-checkout`/`-n`, `--bare`, +or `--mirror` is given) --[no-]shallow-submodules:: All submodules which are cloned will be shallow with a depth of 1. |