Merge branch 'fix'

[git.git] / Documentation / git-clone.txt

diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt
index cbd83f3..b333f51 100644 (file)
--- a/Documentation/git-clone.txt
+++ b/Documentation/git-clone.txt
@@ -3,12 +3,15 @@ git-clone(1)
 
 NAME
 ----
 
 NAME
 ----

-git-clone - Clones a repository.
+git-clone - Clones a repository

 
 
 SYNOPSIS
 --------
 
 
 SYNOPSIS
 --------

-'git-clone' [-l [-s]] [-q] [-n] [-u <upload-pack>] <repository> <directory>
+[verse]
+'git-clone' [-l [-s]] [-q] [-n] [--bare] [-o <name>] [-u <upload-pack>]
+         [--reference <repository>]
+         <repository> [<directory>]

 
 DESCRIPTION
 -----------
 
 DESCRIPTION
 -----------


@@ -25,7 +28,8 @@ This is to help the typical workflow of working off of the
 remote `master` branch.  Every time `git pull` without argument
 is run, the progress on the remote `master` branch is tracked by
 copying it into the local `origin` branch, and merged into the
 remote `master` branch.  Every time `git pull` without argument
 is run, the progress on the remote `master` branch is tracked by
 copying it into the local `origin` branch, and merged into the

-branch you are currently working on.
+branch you are currently working on.  Remote branches other than
+`master` are also added there to be tracked.

 
 
 OPTIONS
 
 
 OPTIONS


@@ -43,10 +47,18 @@ OPTIONS
 -s::
        When the repository to clone is on the local machine,
        instead of using hard links, automatically setup
 -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.
 
        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
 --quiet::
 -q::
        Operate quietly.  This flag is passed to "rsync" and


@@ -55,6 +67,21 @@ OPTIONS
 -n::
        No checkout of HEAD is performed after the clone is complete.
 
 -n::
        No checkout of HEAD is performed after the clone is complete.
 

+--bare::
+       Make a 'bare' GIT repository.  That is, instead of
+       creating `<directory>` and placing the administrative
+       files in `<directory>/.git`, make the `<directory>`
+       itself the `$GIT_DIR`. This implies `-n` option.  When
+       this option is used, neither the `origin` branch nor the
+       default `remotes/origin` file is created.
+
+-o <name>::
+       Instead of using the branch name 'origin' to keep track
+       of the upstream repository, use <name> instead.  Note
+       that the shorthand name stored in `remotes/origin` is
+       not affected, but the local branch name to pull the
+       remote `master` branch into is.
+

 --upload-pack <upload-pack>::
 -u <upload-pack>::
        When given, and the repository to clone from is handled
 --upload-pack <upload-pack>::
 -u <upload-pack>::
        When given, and the repository to clone from is handled


@@ -67,17 +94,66 @@ OPTIONS
        be any URL git-fetch supports.
 
 <directory>::
        be any URL git-fetch supports.
 
 <directory>::

-       The name of a new directory to be cloned into.  It is an
-       error to specify an existing directory.
+       The name of a new directory to clone into.  The "humanish"
+       part of the source repository is used if no directory is
+       explicitly given ("repo" for "/path/to/repo.git" and "foo"
+       for "host.xz:foo/.git").  Cloning into an existing directory
+       is not allowed.
+
+Examples
+--------
+
+Clone from upstream::
++
+------------
+$ git clone git://git.kernel.org/pub/scm/.../linux-2.6 my2.6
+$ cd my2.6
+$ make
+------------
+
+
+Make a local clone that borrows from the current directory, without checking things out::
++
+------------
+$ git clone -l -s -n . ../copy
+$ cd copy
+$ 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::
++
+------------
+$ git clone --bare -l /home/proj/.git /pub/scm/proj.git
+------------
+
+
+Create a repository on the kernel.org machine that borrows from Linus::
++
+------------
+$ git clone --bare -l -s /pub/scm/.../torvalds/linux-2.6.git \
+    /pub/scm/.../me/subsys-2.6.git
+------------

 
 
 Author
 ------
 Written by Linus Torvalds <torvalds@osdl.org>
 
 
 
 Author
 ------
 Written by Linus Torvalds <torvalds@osdl.org>
 

+

 Documentation
 --------------
 Documentation
 --------------

-Documentation by Junio C Hamano.
+Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.

 
 
 GIT
 
 
 GIT