From: Christian Schlotter <schlotter@users.sourceforge.net>
To: git@vger.kernel.org
Cc: Christian Schlotter <schlotter@users.sourceforge.net>
Subject: [PATCH] git-clone: Sync documentation to usage note.
Date: Thu, 15 Feb 2007 23:13:54 +0100 [thread overview]
Message-ID: <117157763494-git-send-email-schlotter@users.sourceforge.net> (raw)
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
next reply other threads:[~2007-02-15 22:15 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2007-02-15 22:13 Christian Schlotter [this message]
2007-02-15 22:38 ` [PATCH] git-clone: Sync documentation to usage note Shawn O. Pearce
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=117157763494-git-send-email-schlotter@users.sourceforge.net \
--to=schlotter@users.sourceforge.net \
--cc=git@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.