From 28a1b56932c222b326e4ac0cd480d4e0be72fb1c Mon Sep 17 00:00:00 2001 From: Sebastian Schuberth Date: Wed, 6 Jan 2016 14:06:47 +0100 Subject: [PATCH] docs: clarify that passing --depth to git-clone implies --single-branch It is confusing to document how --depth behaves as part of the --single-branch docs. Better move that part to the --depth docs, saying that it implies --single-branch by default. Signed-off-by: Sebastian Schuberth Signed-off-by: Junio C Hamano --- Documentation/git-clone.txt | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt index 0363d0039b..dd8271478a 100644 --- a/Documentation/git-clone.txt +++ b/Documentation/git-clone.txt @@ -178,15 +178,14 @@ objects from the source repository into a pack in the cloned repository. --depth :: Create a 'shallow' clone with a history truncated to the - specified number of revisions. + specified number of revisions. Implies `--single-branch` unless + `--no-single-branch` is given to fetch the histories near the + tips of all branches. --[no-]single-branch:: Clone only the history leading to the tip of a single branch, either specified by the `--branch` option or the primary - branch remote's `HEAD` points at. When creating a shallow - clone with the `--depth` option, this is the default, unless - `--no-single-branch` is given to fetch the histories near the - tips of all branches. + branch remote's `HEAD` points at. Further fetches into the resulting repository will only update the remote-tracking branch for the branch this option was used for the initial cloning. If the HEAD at the remote did not point at any -- 2.11.4.GIT