git-clone: Sync documentation to usage note.
authorChristian Schlotter <schlotter@users.sourceforge.net>
Mon, 19 Feb 2007 12:35:35 +0000 (13:35 +0100)
committerJunio C Hamano <junkio@cox.net>
Tue, 20 Feb 2007 02:14:29 +0000 (18:14 -0800)
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.

Signed-off-by: Christian Schlotter <schlotter@users.sourceforge.net>
Signed-off-by: Junio C Hamano <junkio@cox.net>
Documentation/RelNotes-1.5.0.txt
Documentation/git-clone.txt

index 599efb8c908d96e4de938458654cbbe907cf00bb..daf4bdb0d7bb24319810fe0e73aa317663448c93 100644 (file)
@@ -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:
 
index 707376f22cf2c849aae4cfca463d239b5f4fdf68..6d32c491a591daa183424a8743ed119e07631b27 100644 (file)
@@ -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