summaryrefslogtreecommitdiff
path: root/Documentation/git-clone.txt
diff options
context:
space:
mode:
authorJunio C Hamano <junkio@cox.net>2007-01-01 23:08:06 (GMT)
committerJunio C Hamano <junkio@cox.net>2007-01-01 23:08:06 (GMT)
commitf4bf2184ae8b79f95b9f56c1ea5455d04e559299 (patch)
tree413ae7c834e5aaa7524b5de6c3139355b13a542f /Documentation/git-clone.txt
parenta597fb0e713d172a34efb4bf6f65cf2f64cf4536 (diff)
downloadgit-f4bf2184ae8b79f95b9f56c1ea5455d04e559299.zip
git-f4bf2184ae8b79f95b9f56c1ea5455d04e559299.tar.gz
git-f4bf2184ae8b79f95b9f56c1ea5455d04e559299.tar.bz2
Update clone/fetch documentation with --depth (shallow clone) option
Signed-off-by: Junio C Hamano <junkio@cox.net>
Diffstat (limited to 'Documentation/git-clone.txt')
-rw-r--r--Documentation/git-clone.txt12
1 files changed, 11 insertions, 1 deletions
diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt
index 9652320..e7085fd 100644
--- a/Documentation/git-clone.txt
+++ b/Documentation/git-clone.txt
@@ -11,7 +11,7 @@ SYNOPSIS
[verse]
'git-clone' [--template=<template_directory>] [-l [-s]] [-q] [-n] [--bare]
[-o <name>] [-u <upload-pack>] [--reference <repository>]
- <repository> [<directory>]
+ [--depth=<depth>] <repository> [<directory>]
DESCRIPTION
-----------
@@ -31,6 +31,7 @@ the remote branch heads under `$GIT_DIR/refs/remotes/origin` and
by initializing `remote.origin.url` and `remote.origin.fetch`
configuration variables.
+
OPTIONS
-------
--local::
@@ -95,6 +96,15 @@ OPTIONS
if unset the templates are taken from the installation
defined default, typically `/usr/share/git-core/templates`.
+--depth=<depth>::
+ Create a 'shallow' clone with a history truncated to the
+ specified number of revs. A shallow repository has
+ number of limitations (you cannot clone or fetch from
+ it, nor push from nor into it), but is adequate if you
+ want to only look at near the tip of a large project
+ with a long history, and would want to send in a fixes
+ as patches.
+
<repository>::
The (possibly remote) repository to clone from. It can
be any URL git-fetch supports.