summaryrefslogtreecommitdiff
path: root/Documentation/git-clone.txt
blob: 790b87b231d46d6e9de9d85024b25b49ee225488 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
git-clone(1)
============
 
NAME
----
git-clone - Clones a repository.
 
 
SYNOPSIS
--------
[verse]
'git-clone' [-l [-s]] [-q] [-n] [-o <name>] [-u <upload-pack>]
	  <repository> [<directory>]
 
DESCRIPTION
-----------
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
	mechanism and clones the repository by making a copy of
	HEAD and everything under objects and refs directories.
	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.
 
-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
	by 'git-clone-pack', '--exec=<upload-pack>' is passed to
	the command to specify non-default path for the command
	run on the other end.
 
<repository>::
	The (possibly remote) repository to clone from.  It can
	be any URL git-fetch supports.
 
<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
------------
 
Author
------
Written by Linus Torvalds <torvalds@osdl.org>
 
 
Documentation
--------------
Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
 
 
GIT
---
Part of the gitlink:git[7] suite