Skip to content

Commit

Permalink
git-clone: Sync documentation to usage note.
Browse files Browse the repository at this point in the history
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 <[email protected]>
Signed-off-by: Junio C Hamano <[email protected]>
  • Loading branch information
Christian Schlotter authored and Junio C Hamano committed Feb 20, 2007
1 parent 4bc94d2 commit f496454
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion Documentation/RelNotes-1.5.0.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
4 changes: 2 additions & 2 deletions Documentation/git-clone.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
-----------
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit f496454

Please sign in to comment.