X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=Documentation%2Fgit-clone.txt;h=6d32c491a591daa183424a8743ed119e07631b27;hb=9cec65399d3575774910b21c1cfd762a5e88a245;hp=96523204ddda292bb01a55f042f249515f821613;hpb=9066f4ef2fe27b7636094c06d2361820cd31e03e;p=git.git

diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt
index 96523204d..6d32c491a 100644
--- a/Documentation/git-clone.txt
+++ b/Documentation/git-clone.txt
@@ -3,7 +3,7 @@ git-clone(1)
 
 NAME
 ----
-git-clone - Clones a repository
+git-clone - Clones a repository into a new directory
 
 
 SYNOPSIS
@@ -11,26 +11,27 @@ 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
 -----------
 
 Clones a repository into a newly created directory, creates
 remote-tracking branches for each branch in the cloned repository
-(visible using `git branch -r`), and creates and checks out a master
-branch equal to the cloned repository's master branch.
+(visible using `git branch -r`), and creates and checks out an initial
+branch equal to the cloned repository's currently active branch.
 
 After the clone, a plain `git fetch` without arguments will update
 all the remote-tracking branches, and a `git pull` without
 arguments will in addition merge the remote master branch into the
-current branch.
+current master branch, if any.
 
 This default configuration is achieved by creating references to
 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
 	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.