summaryrefslogtreecommitdiff
path: root/Documentation/git-clone.txt
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2016-05-06 21:45:43 (GMT)
committerJunio C Hamano <gitster@pobox.com>2016-05-06 21:45:43 (GMT)
commit5f3b21c1119abc7e19c988b399c7726d47bbb0d1 (patch)
tree1a89aa68fe3d548cf24de1476eaaf1e52e27d1e4 /Documentation/git-clone.txt
parentca158f4633e40fb8a6e7e6b78dc7ad559718a19b (diff)
parentd22eb044750631f30bdbfc3dc42d684e73d18ddc (diff)
downloadgit-5f3b21c1119abc7e19c988b399c7726d47bbb0d1.zip
git-5f3b21c1119abc7e19c988b399c7726d47bbb0d1.tar.gz
git-5f3b21c1119abc7e19c988b399c7726d47bbb0d1.tar.bz2
Merge branch 'sb/clone-shallow-passthru'
"git clone" learned "--shallow-submodules" option. * sb/clone-shallow-passthru: clone: add `--shallow-submodules` flag
Diffstat (limited to 'Documentation/git-clone.txt')
-rw-r--r--Documentation/git-clone.txt11
1 files changed, 8 insertions, 3 deletions
diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt
index 45d74be..1b15cd7 100644
--- a/Documentation/git-clone.txt
+++ b/Documentation/git-clone.txt
@@ -14,8 +14,8 @@ SYNOPSIS
[-o <name>] [-b <name>] [-u <upload-pack>] [--reference <repository>]
[--dissociate] [--separate-git-dir <git dir>]
[--depth <depth>] [--[no-]single-branch]
- [--recursive | --recurse-submodules] [--jobs <n>] [--] <repository>
- [<directory>]
+ [--recursive | --recurse-submodules] [--[no-]shallow-submodules]
+ [--jobs <n>] [--] <repository> [<directory>]
DESCRIPTION
-----------
@@ -191,7 +191,9 @@ objects from the source repository into a pack in the cloned repository.
Create a 'shallow' clone with a history truncated to the
specified number of commits. Implies `--single-branch` unless
`--no-single-branch` is given to fetch the histories near the
- tips of all branches.
+ tips of all branches. This implies `--shallow-submodules`. If
+ you want to have a shallow superproject clone, but full submodules,
+ also pass `--no-shallow-submodules`.
--[no-]single-branch::
Clone only the history leading to the tip of a single branch,
@@ -212,6 +214,9 @@ objects from the source repository into a pack in the cloned repository.
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.
+
--separate-git-dir=<git dir>::
Instead of placing the cloned repository where it is supposed
to be, place the cloned repository at the specified directory,