ls-tree: further tweaks of the rewrite
[gitweb.git] / Documentation / git-clone.txt
index bd53ef430dd83adc8f0940fe130ced3fe1693ab0..83f58ae5365f05297a432cbd147c496e9fff8ba1 100644 (file)
@@ -1,6 +1,5 @@
 git-clone(1)
 ============
-v0.1, July 2005
 
 NAME
 ----
@@ -9,14 +8,30 @@ git-clone - Clones a repository.
 
 SYNOPSIS
 --------
-'git clone' [-l] [-u <upload-pack>] [-q] <repository> <directory>
+'git-clone' [-l [-s]] [-q] [-n] [-u <upload-pack>] <repository> [<directory>]
 
 DESCRIPTION
 -----------
-Clones a repository into a newly created directory.
+Clones a repository into a newly created directory.  All remote
+branch heads are copied under `$GIT_DIR/refs/heads/`, except
+that the remote `master` is also copied to `origin` branch.
+
+In addition, `$GIT_DIR/remotes/origin` file is set up to have
+this line:
+
+       Pull: master:origin
+
+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
+branch you are currently working on.  Remote branches other than
+`master` are also added there to be tracked.
+
 
 OPTIONS
 -------
+--local::
 -l::
        When the repository to clone from is on a local machine,
        this flag bypasses normal "git aware" transport
@@ -25,10 +40,23 @@ OPTIONS
        The files under .git/objects/ directory are hardlinked
        to save space when possible.
 
+--shared::
+-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
+       with the source repository.  The resulting repository
+       starts out without any object of its own.
+
+--quiet::
 -q::
        Operate quietly.  This flag is passed to "rsync" and
        "git-clone-pack" commands when given.
 
+-n::
+       No checkout of HEAD is performed after the clone is complete.
+
+--upload-pack <upload-pack>::
 -u <upload-pack>::
        When given, and the repository to clone from is handled
        by 'git-clone-pack', '--exec=<upload-pack>' is passed to
@@ -37,13 +65,14 @@ OPTIONS
 
 <repository>::
        The (possibly remote) repository to clone from.  It can
-       be an "rsync://host/dir" URL, an "http://host/dir" URL,
-       or [<host>:]/dir notation that is used by 'git-clone-pack'.
-       Currently http transport is not supported.
+       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.
 
 Author
 ------
@@ -51,7 +80,7 @@ Written by Linus Torvalds <torvalds@osdl.org>
 
 Documentation
 --------------
-Documentation by Junio C Hamano.
+Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
 
 
 GIT