git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH] git-clone: Sync documentation to usage note.
@ 2007-02-15 22:13 Christian Schlotter
  2007-02-15 22:38 ` Shawn O. Pearce
  0 siblings, 1 reply; 2+ messages in thread
From: Christian Schlotter @ 2007-02-15 22:13 UTC (permalink / raw)
  To: git; +Cc: Christian Schlotter

Documentation advertises the new `--depth <n>' 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 <schlotter@users.sourceforge.net>
---
 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=<template_directory>] [-l [-s]] [-q] [-n] [--bare]
 	  [-o <name>] [-u <upload-pack>] [--reference <repository>]
-	  [--depth=<depth>] <repository> [<directory>]
+	  [--depth <depth>] <repository> [<directory>]
 
 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>::
+--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

^ permalink raw reply related	[flat|nested] 2+ messages in thread

* Re: [PATCH] git-clone: Sync documentation to usage note.
  2007-02-15 22:13 [PATCH] git-clone: Sync documentation to usage note Christian Schlotter
@ 2007-02-15 22:38 ` Shawn O. Pearce
  0 siblings, 0 replies; 2+ messages in thread
From: Shawn O. Pearce @ 2007-02-15 22:38 UTC (permalink / raw)
  To: Christian Schlotter; +Cc: git

Christian Schlotter <schlotter@users.sourceforge.net> wrote:
> 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?

Sort of.  ;-)

The server side must also support shallow clone.  I don't think
the server on kernel.org has been upgraded yet to a version which
supports that feature, so you cannot shallow clone from there.

-- 
Shawn.

^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2007-02-15 22:38 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2007-02-15 22:13 [PATCH] git-clone: Sync documentation to usage note Christian Schlotter
2007-02-15 22:38 ` Shawn O. Pearce

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).