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

Signed-off-by: Junio C Hamano <junkio@cox.net>

diff --git a/Documentation/fetch-options.txt b/Documentation/fetch-options.txt
index 39bf77fbef2f7b0b113ad7c478fa260f6984f0cb..5b4d184a73d013b8da11db3adb08905c0101bf88 100644 (file)
--- a/Documentation/fetch-options.txt
+++ b/Documentation/fetch-options.txt
@@ -41,3 +41,8 @@
        implementing your own Porcelain you are not supposed to
        use it.
 
        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.
+

diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt
index 96523204ddda292bb01a55f042f249515f821613..e7085fdf5fe61520c2a138f971b39420775245c7 100644 (file)
--- 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>]
 [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
 -----------
 
 DESCRIPTION
 -----------


@@ -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.
 
 by initializing `remote.origin.url` and `remote.origin.fetch`
 configuration variables.
 

+

 OPTIONS
 -------
 --local::
 OPTIONS
 -------
 --local::


@@ -95,6 +96,15 @@ OPTIONS
        if unset the templates are taken from the installation
        defined default, typically `/usr/share/git-core/templates`.
 
        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.
 <repository>::
        The (possibly remote) repository to clone from.  It can
        be any URL git-fetch supports.