From: Christian Schlotter Date: Thu, 15 Feb 2007 22:13:54 GMT Subject: [PATCH] git-clone: Sync documentation to usage note. Message-ID: <117157763494-git-send-email-schlotter@users.sourceforge.net> Documentation advertises the new `--depth ' parameter with an equal sign, while the usage notes (shown after `git-clone --help') do not. If I understood git-clone's source code correctly, the version without the equal sign is correct, which is why this patch syncs documentation to the usage note. Please note that I was not able to test the new shallow clone feature, as both git clone --depth=5 git://git2.kernel.org/pub/scm/git/git.git and git clone --depth 5 git://git2.kernel.org/pub/scm/git/git.git do not seem to work. The former correctly produces the usage note, while the latter prints Initialized empty Git repository in /home/cs/tmp2/git/.git/ fatal: read error (Connection reset by peer) fetch-pack from 'git://git2.kernel.org/pub/scm/git/git.git' failed. Is this a problem on my end? Signed-off-by: Christian Schlotter --- Documentation/RelNotes-1.5.0.txt | 2 +- Documentation/git-clone.txt | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/Documentation/RelNotes-1.5.0.txt b/Documentation/RelNotes-1.5.0.txt index 599efb8..daf4bdb 100644 --- a/Documentation/RelNotes-1.5.0.txt +++ b/Documentation/RelNotes-1.5.0.txt @@ -448,7 +448,7 @@ Updates in v1.5.0 since v1.4.4 series - There is a partial support for 'shallow' repositories that keeps only recent history. A 'shallow clone' is created by specifying how deep that truncated history should be - (e.g. "git clone --depth=5 git://some.where/repo.git"). + (e.g. "git clone --depth 5 git://some.where/repo.git"). Currently a shallow repository has number of limitations: diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt index 707376f..6d32c49 100644 --- a/Documentation/git-clone.txt +++ b/Documentation/git-clone.txt @@ -11,7 +11,7 @@ SYNOPSIS [verse] 'git-clone' [--template=] [-l [-s]] [-q] [-n] [--bare] [-o ] [-u ] [--reference ] - [--depth=] [] + [--depth ] [] DESCRIPTION ----------- @@ -96,7 +96,7 @@ 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 -- 1.5.0