X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=Documentation%2Fgit-clone.txt;h=83f58ae5365f05297a432cbd147c496e9fff8ba1;hb=bce8230d5d897a738cc004954df71f50a40295db;hp=dd92cdefc2a2c504aea8ca23ce0e01746020036f;hpb=8ac3a61f59173d4a9a328518be83a25df610a5ef;p=git.git diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt index dd92cdef..83f58ae5 100644 --- a/Documentation/git-clone.txt +++ b/Documentation/git-clone.txt @@ -8,11 +8,26 @@ git-clone - Clones a repository. SYNOPSIS -------- -'git-clone' [-l [-s]] [-q] [-n] [-u ] +'git-clone' [-l [-s]] [-q] [-n] [-u ] [] 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 ------- @@ -28,9 +43,10 @@ OPTIONS --shared:: -s:: When the repository to clone is on the local machine, - instead of using hard links automatically setup + instead of using hard links, automatically setup .git/objects/info/alternatives to share the objects - with the source repository + with the source repository. The resulting repository + starts out without any object of its own. --quiet:: -q:: @@ -49,13 +65,14 @@ OPTIONS :: The (possibly remote) repository to clone from. It can - be an "rsync://host/dir" URL, an "http://host/dir" URL, - or [:]/dir notation that is used by 'git-clone-pack'. - Currently http transport is not supported. + be any URL git-fetch supports. :: - 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 ------ @@ -63,7 +80,7 @@ Written by Linus Torvalds Documentation -------------- -Documentation by Junio C Hamano. +Documentation by Junio C Hamano and the git-list . GIT