summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorShawn Pearce <spearce@spearce.org>2006-04-19 00:19:48 (GMT)
committerJunio C Hamano <junkio@cox.net>2006-04-19 00:56:53 (GMT)
commit23edecbc9a5566ac5aa8fb251fbcf8bb83694837 (patch)
tree4a79b6687bc8b78aac6dccbbad12700302fd6fd0 /Documentation
parent8d6e10327dff232cc253a5753c43fb414fed4e00 (diff)
downloadgit-23edecbc9a5566ac5aa8fb251fbcf8bb83694837.zip
git-23edecbc9a5566ac5aa8fb251fbcf8bb83694837.tar.gz
git-23edecbc9a5566ac5aa8fb251fbcf8bb83694837.tar.bz2
Document git-clone --reference
The new --reference flag introduced to git-clone in GIT 1.3.0 was not documented but is rather handy. So document it. Also corrected a minor issue with the documentation for the -s flag; the info/alternates file name was spelled wrong. Signed-off-by: Shawn O. Pearce <spearce@spearce.org> Signed-off-by: Junio C Hamano <junkio@cox.net>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/git-clone.txt21
1 files changed, 20 insertions, 1 deletions
diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt
index 9ac54c2..131e445 100644
--- a/Documentation/git-clone.txt
+++ b/Documentation/git-clone.txt
@@ -10,6 +10,7 @@ SYNOPSIS
--------
[verse]
'git-clone' [-l [-s]] [-q] [-n] [--bare] [-o <name>] [-u <upload-pack>]
+ [--reference <repository>]
<repository> [<directory>]
DESCRIPTION
@@ -46,10 +47,18 @@ OPTIONS
-s::
When the repository to clone is on the local machine,
instead of using hard links, automatically setup
- .git/objects/info/alternatives to share the objects
+ .git/objects/info/alternates to share the objects
with the source repository. The resulting repository
starts out without any object of its own.
+--reference <repository>::
+ If the reference repository is on the local machine
+ automatically setup .git/objects/info/alternates to
+ obtain objects from the reference repository. Using
+ an already existing repository as an alternate will
+ require less objects to be copied from the repository
+ being cloned, reducing network and local storage costs.
+
--quiet::
-q::
Operate quietly. This flag is passed to "rsync" and
@@ -112,6 +121,16 @@ $ git show-branch
------------
+Clone from upstream while borrowing from an existing local directory::
++
+------------
+$ git clone --reference my2.6 \
+ git://git.kernel.org/pub/scm/.../linux-2.7 \
+ my2.7
+$ cd my2.7
+------------
+
+
Create a bare repository to publish your changes to the public::
+
------------