X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=Documentation%2Fgit-clone.txt;h=83f58ae5365f05297a432cbd147c496e9fff8ba1;hb=80b1e511d74ac2942043f912d850cb6b85b44689;hp=cff87ea1dc0f3f02ddebb8f1c1375cb2b3ef9cd1;hpb=215a7ad1ef790467a4cd3f0dcffbd6e5f04c38f7;p=git.git diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt index cff87ea1..83f58ae5 100644 --- a/Documentation/git-clone.txt +++ b/Documentation/git-clone.txt @@ -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 ] [-q] +'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 ------- +--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 :: -u :: When given, and the repository to clone from is handled by 'git-clone-pack', '--exec=' is passed to @@ -37,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 ------ @@ -51,10 +80,10 @@ Written by Linus Torvalds Documentation -------------- -Documentation by Junio C Hamano. +Documentation by Junio C Hamano and the git-list . GIT --- -Part of the link:git.html[git] suite +Part of the gitlink:git[7] suite