diff options
| author | Junio C Hamano <junkio@cox.net> | 2005-11-05 22:26:52 -0800 |
|---|---|---|
| committer | Junio C Hamano <junkio@cox.net> | 2005-11-06 00:26:21 -0800 |
| commit | 4607166d0735d13e0ee4ffe8df0c2fc899957852 (patch) | |
| tree | 48f8aa4a29bebaa82c792302a9c7e59bb6265869 /Documentation/git-clone.txt | |
| parent | b748421aaae3fbb8e0e6466ba532bcec1c71e660 (diff) | |
| download | git-4607166d0735d13e0ee4ffe8df0c2fc899957852.tar.gz | |
Documentation: pull/clone ref mapping clarification.
Josef Weidendorfer points out that git-clone documentation does not
mention the initial copying of remote branch heads into corresponding
local branches. Also clarify the purpose of the ref mappings description
in the "remotes" file and recommended workflow.
Signed-off-by: Junio C Hamano <junkio@cox.net>
Diffstat (limited to 'Documentation/git-clone.txt')
| -rw-r--r-- | Documentation/git-clone.txt | 26 |
1 files changed, 20 insertions, 6 deletions
diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt index dd92cdefc2..cbd83f35d7 100644 --- a/Documentation/git-clone.txt +++ b/Documentation/git-clone.txt @@ -12,7 +12,21 @@ SYNOPSIS 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. + OPTIONS ------- @@ -28,9 +42,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,14 +64,13 @@ 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. + Author ------ Written by Linus Torvalds <torvalds@osdl.org> |