summaryrefslogtreecommitdiff
path: root/Documentation/config/clone.txt
diff options
context:
space:
mode:
authorLibravatar Li Linchao <lilinchao@oschina.cn>2021-04-01 10:46:59 +0000
committerLibravatar Junio C Hamano <gitster@pobox.com>2021-04-01 12:58:58 -0700
commit4fe788b1b0ee6150173580d8fa70e7d5788cf7d3 (patch)
tree6fb69c5ec68dcfa0bf1e0887726a99cc8749dfa5 /Documentation/config/clone.txt
parentSync with v2.31.1 (diff)
downloadtgif-4fe788b1b0ee6150173580d8fa70e7d5788cf7d3.tar.xz
builtin/clone.c: add --reject-shallow option
In some scenarios, users may want more history than the repository offered for cloning, which happens to be a shallow repository, can give them. But because users don't know it is a shallow repository until they download it to local, we may want to refuse to clone this kind of repository, without creating any unnecessary files. The '--depth=x' option cannot be used as a solution; the source may be deep enough to give us 'x' commits when cloned, but the user may later need to deepen the history to arbitrary depth. Teach '--reject-shallow' option to "git clone" to abort as soon as we find out that we are cloning from a shallow repository. Signed-off-by: Li Linchao <lilinchao@oschina.cn> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/config/clone.txt')
-rw-r--r--Documentation/config/clone.txt4
1 files changed, 4 insertions, 0 deletions
diff --git a/Documentation/config/clone.txt b/Documentation/config/clone.txt
index 47de36a5fe..7bcfbd18a5 100644
--- a/Documentation/config/clone.txt
+++ b/Documentation/config/clone.txt
@@ -2,3 +2,7 @@ clone.defaultRemoteName::
The name of the remote to create when cloning a repository. Defaults to
`origin`, and can be overridden by passing the `--origin` command-line
option to linkgit:git-clone[1].
+
+clone.rejectShallow::
+ Reject to clone a repository if it is a shallow one, can be overridden by
+ passing option `--reject-shallow` in command line. See linkgit:git-clone[1]