Browse Source

Update clone/fetch documentation with --depth (shallow clone) option

Signed-off-by: Junio C Hamano <junkio@cox.net>
maint
Junio C Hamano 18 years ago
parent
commit
f4bf2184ae
  1. 5
      Documentation/fetch-options.txt
  2. 12
      Documentation/git-clone.txt

5
Documentation/fetch-options.txt

@ -41,3 +41,8 @@ @@ -41,3 +41,8 @@
implementing your own Porcelain you are not supposed to
use it.

\--depth=<depth>::
Deepen the history of a 'shallow' repository created by
`git clone` with `--depth=<depth>` option (see gitlink:git-clone[1])
by the specified number of commits.


12
Documentation/git-clone.txt

@ -11,7 +11,7 @@ SYNOPSIS @@ -11,7 +11,7 @@ SYNOPSIS
[verse]
'git-clone' [--template=<template_directory>] [-l [-s]] [-q] [-n] [--bare]
[-o <name>] [-u <upload-pack>] [--reference <repository>]
<repository> [<directory>]
[--depth=<depth>] <repository> [<directory>]

DESCRIPTION
-----------
@ -31,6 +31,7 @@ the remote branch heads under `$GIT_DIR/refs/remotes/origin` and @@ -31,6 +31,7 @@ the remote branch heads under `$GIT_DIR/refs/remotes/origin` and
by initializing `remote.origin.url` and `remote.origin.fetch`
configuration variables.


OPTIONS
-------
--local::
@ -95,6 +96,15 @@ OPTIONS @@ -95,6 +96,15 @@ 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
it, nor push from nor into it), but is adequate if you
want to only look at near the tip of a large project
with a long history, and would want to send in a fixes
as patches.

<repository>::
The (possibly remote) repository to clone from. It can
be any URL git-fetch supports.

Loading…
Cancel
Save