user-manual: point to README for gitweb information
[gitweb.git] / Documentation / git-clone.txt
index 96523204ddda292bb01a55f042f249515f821613..a78207461db41172114b865a49b068fe4aac2a9a 100644 (file)
@@ -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.