Google Git
Sign in
chromium / external / gitster / git-htmldocs / 0bbd467b4f8dc271d63ec8412b6a8a934b11aa0b / . / git-clone.html
blob: 1325df92b34aa7fa55a947d43297f2920ae06826 [file] [log] [blame]
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
4<head>
5<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
Junio C Hamano01078922006-03-10 00:31:47[diff] [blame]6<meta name="generator" content="AsciiDoc 7.0.2" />
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]7<style type="text/css">
8/* Debug borders */
9p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
10/*
11 border: 1px solid red;
12*/
13}
14
15body {
16 margin: 1em 5% 1em 5%;
17}
18
19a { color: blue; }
20a:visited { color: fuchsia; }
21
22em {
23 font-style: italic;
24}
25
26strong {
27 font-weight: bold;
28}
29
30tt {
31 color: navy;
32}
33
34h1, h2, h3, h4, h5, h6 {
35 color: #527bbd;
36 font-family: sans-serif;
37 margin-top: 1.2em;
38 margin-bottom: 0.5em;
39 line-height: 1.3;
40}
41
42h1 {
43 border-bottom: 2px solid silver;
44}
45h2 {
46 border-bottom: 2px solid silver;
47 padding-top: 0.5em;
48}
49
50div.sectionbody {
51 font-family: serif;
52 margin-left: 0;
53}
54
55hr {
56 border: 1px solid silver;
57}
58
59p {
60 margin-top: 0.5em;
61 margin-bottom: 0.5em;
62}
63
64pre {
65 padding: 0;
66 margin: 0;
67}
68
69span#author {
70 color: #527bbd;
71 font-family: sans-serif;
72 font-weight: bold;
73 font-size: 1.2em;
74}
75span#email {
76}
77span#revision {
78 font-family: sans-serif;
79}
80
81div#footer {
82 font-family: sans-serif;
83 font-size: small;
84 border-top: 2px solid silver;
85 padding-top: 0.5em;
86 margin-top: 4.0em;
87}
88div#footer-text {
89 float: left;
90 padding-bottom: 0.5em;
91}
92div#footer-badges {
93 float: right;
94 padding-bottom: 0.5em;
95}
96
97div#preamble,
98div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
99div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
100div.admonitionblock {
101 margin-right: 10%;
102 margin-top: 1.5em;
103 margin-bottom: 1.5em;
104}
105div.admonitionblock {
106 margin-top: 2.5em;
107 margin-bottom: 2.5em;
108}
109
110div.content { /* Block element content. */
111 padding: 0;
112}
113
114/* Block element titles. */
115div.title, caption.title {
116 font-family: sans-serif;
117 font-weight: bold;
118 text-align: left;
119 margin-top: 1.0em;
120 margin-bottom: 0.5em;
121}
122div.title + * {
123 margin-top: 0;
124}
125
126td div.title:first-child {
127 margin-top: 0.0em;
128}
129div.content div.title:first-child {
130 margin-top: 0.0em;
131}
132div.content + div.title {
133 margin-top: 0.0em;
134}
135
136div.sidebarblock > div.content {
137 background: #ffffee;
138 border: 1px solid silver;
139 padding: 0.5em;
140}
141
142div.listingblock > div.content {
143 border: 1px solid silver;
144 background: #f4f4f4;
145 padding: 0.5em;
146}
147
148div.quoteblock > div.content {
149 padding-left: 2.0em;
150}
151div.quoteblock .attribution {
152 text-align: right;
153}
154
155div.admonitionblock .icon {
156 vertical-align: top;
157 font-size: 1.1em;
158 font-weight: bold;
159 text-decoration: underline;
160 color: #527bbd;
161 padding-right: 0.5em;
162}
163div.admonitionblock td.content {
164 padding-left: 0.5em;
165 border-left: 2px solid silver;
166}
167
168div.exampleblock > div.content {
169 border-left: 2px solid silver;
170 padding: 0.5em;
171}
172
173div.verseblock div.content {
174 white-space: pre;
175}
176
177div.imageblock div.content { padding-left: 0; }
178div.imageblock img { border: 1px solid silver; }
179span.image img { border-style: none; }
180
181dl {
182 margin-top: 0.8em;
183 margin-bottom: 0.8em;
184}
185dt {
186 margin-top: 0.5em;
187 margin-bottom: 0;
188 font-style: italic;
189}
190dd > *:first-child {
191 margin-top: 0;
192}
193
194ul, ol {
195 list-style-position: outside;
196}
197ol.olist2 {
198 list-style-type: lower-alpha;
199}
200
201div.tableblock > table {
202 border-color: #527bbd;
203 border-width: 3px;
204}
205thead {
206 font-family: sans-serif;
207 font-weight: bold;
208}
209tfoot {
210 font-weight: bold;
211}
212
213div.hlist {
214 margin-top: 0.8em;
215 margin-bottom: 0.8em;
216}
217td.hlist1 {
218 vertical-align: top;
219 font-style: italic;
220 padding-right: 0.8em;
221}
222td.hlist2 {
223 vertical-align: top;
224}
225
226@media print {
227 div#footer-badges { display: none; }
228}
229include::./stylesheets/xhtml11-manpage.css[]
230/* Workarounds for IE6's broken and incomplete CSS2. */
231
232div.sidebar-content {
233 background: #ffffee;
234 border: 1px solid silver;
235 padding: 0.5em;
236}
237div.sidebar-title, div.image-title {
238 font-family: sans-serif;
239 font-weight: bold;
240 margin-top: 0.0em;
241 margin-bottom: 0.5em;
242}
243
244div.listingblock div.content {
245 border: 1px solid silver;
246 background: #f4f4f4;
247 padding: 0.5em;
248}
249
250div.quoteblock-content {
251 padding-left: 2.0em;
252}
253
254div.exampleblock-content {
255 border-left: 2px solid silver;
256 padding-left: 0.5em;
257}
258</style>
259<title>git-clone(1)</title>
260</head>
261<body>
262<div id="header">
263<h1>
264git-clone(1) Manual Page
265</h1>
266<h2>NAME</h2>
267<div class="sectionbody">
268<p>git-clone -
Junio C Hamano7c73c662007-01-19 00:37:50[diff] [blame]269 Clones a repository into a new directory
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]270</p>
271</div>
272</div>
273<h2>SYNOPSIS</h2>
274<div class="sectionbody">
Junio C Hamano235a91e2006-01-07 01:13:58[diff] [blame]275<div class="verseblock">
Junio C Hamanof31d9f52006-05-28 20:58:09[diff] [blame]276<div class="content"><em>git-clone</em> [--template=&lt;template_directory&gt;] [-l [-s]] [-q] [-n] [--bare]
277 [-o &lt;name&gt;] [-u &lt;upload-pack&gt;] [--reference &lt;repository&gt;]
Junio C Hamano0bbd4672007-02-20 04:52:14[diff] [blame^]278 [--depth &lt;depth&gt;] &lt;repository&gt; [&lt;directory&gt;]</div></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]279</div>
280<h2>DESCRIPTION</h2>
281<div class="sectionbody">
Junio C Hamano5102d9a2006-12-08 07:23:46[diff] [blame]282<p>Clones a repository into a newly created directory, creates
283remote-tracking branches for each branch in the cloned repository
Junio C Hamano79770b62007-01-07 07:43:58[diff] [blame]284(visible using <tt>git branch -r</tt>), and creates and checks out an initial
285branch equal to the cloned repository's currently active branch.</p>
Junio C Hamano5102d9a2006-12-08 07:23:46[diff] [blame]286<p>After the clone, a plain <tt>git fetch</tt> without arguments will update
287all the remote-tracking branches, and a <tt>git pull</tt> without
288arguments will in addition merge the remote master branch into the
Junio C Hamano79770b62007-01-07 07:43:58[diff] [blame]289current master branch, if any.</p>
Junio C Hamano5102d9a2006-12-08 07:23:46[diff] [blame]290<p>This default configuration is achieved by creating references to
291the remote branch heads under <tt>$GIT_DIR/refs/remotes/origin</tt> and
292by initializing <tt>remote.origin.url</tt> and <tt>remote.origin.fetch</tt>
293configuration variables.</p>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]294</div>
295<h2>OPTIONS</h2>
296<div class="sectionbody">
297<dl>
298<dt>
299--local
300</dt>
301<dt>
302-l
303</dt>
304<dd>
305<p>
306 When the repository to clone from is on a local machine,
307 this flag bypasses normal "git aware" transport
308 mechanism and clones the repository by making a copy of
309 HEAD and everything under objects and refs directories.
310 The files under .git/objects/ directory are hardlinked
311 to save space when possible.
312</p>
313</dd>
314<dt>
315--shared
316</dt>
317<dt>
318-s
319</dt>
320<dd>
321<p>
322 When the repository to clone is on the local machine,
323 instead of using hard links, automatically setup
Junio C Hamanof50bfec2006-04-19 09:44:12[diff] [blame]324 .git/objects/info/alternates to share the objects
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]325 with the source repository. The resulting repository
326 starts out without any object of its own.
327</p>
328</dd>
329<dt>
Junio C Hamanof50bfec2006-04-19 09:44:12[diff] [blame]330--reference &lt;repository&gt;
331</dt>
332<dd>
333<p>
334 If the reference repository is on the local machine
335 automatically setup .git/objects/info/alternates to
336 obtain objects from the reference repository. Using
337 an already existing repository as an alternate will
338 require less objects to be copied from the repository
339 being cloned, reducing network and local storage costs.
340</p>
341</dd>
342<dt>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]343--quiet
344</dt>
345<dt>
346-q
347</dt>
348<dd>
349<p>
350 Operate quietly. This flag is passed to "rsync" and
Junio C Hamano97f518c2006-06-22 19:49:35[diff] [blame]351 "git-fetch-pack" commands when given.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]352</p>
353</dd>
354<dt>
355-n
356</dt>
357<dd>
358<p>
359 No checkout of HEAD is performed after the clone is complete.
360</p>
361</dd>
362<dt>
Junio C Hamanoe663a7a2006-01-25 12:37:28[diff] [blame]363--bare
Junio C Hamano38064d52006-01-15 10:13:49[diff] [blame]364</dt>
365<dd>
366<p>
Junio C Hamanoe663a7a2006-01-25 12:37:28[diff] [blame]367 Make a <em>bare</em> GIT repository. That is, instead of
Junio C Hamano38064d52006-01-15 10:13:49[diff] [blame]368 creating <tt>&lt;directory&gt;</tt> and placing the administrative
369 files in <tt>&lt;directory&gt;/.git</tt>, make the <tt>&lt;directory&gt;</tt>
Junio C Hamano9f292e72006-11-24 11:37:29[diff] [blame]370 itself the <tt>$GIT_DIR</tt>. This obviously implies the <tt>-n</tt>
371 because there is nowhere to check out the working tree.
372 Also the branch heads at the remote are copied directly
373 to corresponding local branch heads, without mapping
374 them to <tt>refs/remotes/origin/</tt>. When this option is
Junio C Hamanod3361ad2007-01-01 03:20:24[diff] [blame]375 used, neither remote-tracking branches nor the related
376 configuration variables are created.
Junio C Hamano38064d52006-01-15 10:13:49[diff] [blame]377</p>
378</dd>
379<dt>
Junio C Hamanodcc22ee2006-11-03 02:40:13[diff] [blame]380--origin &lt;name&gt;
381</dt>
382<dt>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]383-o &lt;name&gt;
384</dt>
385<dd>
386<p>
Junio C Hamanod3361ad2007-01-01 03:20:24[diff] [blame]387 Instead of using the remote name <em>origin</em> to keep track
388 of the upstream repository, use &lt;name&gt; instead.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]389</p>
390</dd>
391<dt>
392--upload-pack &lt;upload-pack&gt;
393</dt>
394<dt>
395-u &lt;upload-pack&gt;
396</dt>
397<dd>
398<p>
399 When given, and the repository to clone from is handled
Junio C Hamano97f518c2006-06-22 19:49:35[diff] [blame]400 by <em>git-fetch-pack</em>, <em>--exec=&lt;upload-pack&gt;</em> is passed to
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]401 the command to specify non-default path for the command
402 run on the other end.
403</p>
404</dd>
405<dt>
Junio C Hamanof31d9f52006-05-28 20:58:09[diff] [blame]406--template=&lt;template_directory&gt;
407</dt>
408<dd>
409<p>
410 Specify the directory from which templates will be used;
411 if unset the templates are taken from the installation
412 defined default, typically <tt>/usr/share/git-core/templates</tt>.
413</p>
414</dd>
415<dt>
Junio C Hamano0bbd4672007-02-20 04:52:14[diff] [blame^]416--depth &lt;depth&gt;
Junio C Hamanob288d9e2007-01-02 00:04:15[diff] [blame]417</dt>
418<dd>
419<p>
420 Create a <em>shallow</em> clone with a history truncated to the
421 specified number of revs. A shallow repository has
422 number of limitations (you cannot clone or fetch from
423 it, nor push from nor into it), but is adequate if you
424 want to only look at near the tip of a large project
425 with a long history, and would want to send in a fixes
426 as patches.
427</p>
428</dd>
429<dt>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]430&lt;repository&gt;
431</dt>
432<dd>
433<p>
434 The (possibly remote) repository to clone from. It can
435 be any URL git-fetch supports.
436</p>
437</dd>
438<dt>
439&lt;directory&gt;
440</dt>
441<dd>
442<p>
443 The name of a new directory to clone into. The "humanish"
444 part of the source repository is used if no directory is
445 explicitly given ("repo" for "/path/to/repo.git" and "foo"
446 for "host.xz:foo/.git"). Cloning into an existing directory
447 is not allowed.
448</p>
449</dd>
450</dl>
Junio C Hamano1bb569e2006-05-05 23:14:25[diff] [blame]451</div>
452<h2>Examples</h2>
453<div class="sectionbody">
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]454<dl>
455<dt>
456Clone from upstream
457</dt>
458<dd>
459<div class="listingblock">
460<div class="content">
461<pre><tt>$ git clone git://git.kernel.org/pub/scm/.../linux-2.6 my2.6
462$ cd my2.6
463$ make</tt></pre>
464</div></div>
465</dd>
466<dt>
467Make a local clone that borrows from the current directory, without checking things out
468</dt>
469<dd>
470<div class="listingblock">
471<div class="content">
472<pre><tt>$ git clone -l -s -n . ../copy
473$ cd copy
474$ git show-branch</tt></pre>
475</div></div>
476</dd>
Junio C Hamano38064d52006-01-15 10:13:49[diff] [blame]477<dt>
Junio C Hamanof50bfec2006-04-19 09:44:12[diff] [blame]478Clone from upstream while borrowing from an existing local directory
479</dt>
480<dd>
481<div class="listingblock">
482<div class="content">
483<pre><tt>$ git clone --reference my2.6 \
484 git://git.kernel.org/pub/scm/.../linux-2.7 \
485 my2.7
486$ cd my2.7</tt></pre>
487</div></div>
488</dd>
489<dt>
Junio C Hamanoe663a7a2006-01-25 12:37:28[diff] [blame]490Create a bare repository to publish your changes to the public
Junio C Hamano38064d52006-01-15 10:13:49[diff] [blame]491</dt>
492<dd>
493<div class="listingblock">
494<div class="content">
Junio C Hamanoe663a7a2006-01-25 12:37:28[diff] [blame]495<pre><tt>$ git clone --bare -l /home/proj/.git /pub/scm/proj.git</tt></pre>
Junio C Hamano38064d52006-01-15 10:13:49[diff] [blame]496</div></div>
497</dd>
498<dt>
499Create a repository on the kernel.org machine that borrows from Linus
500</dt>
501<dd>
502<div class="listingblock">
503<div class="content">
Junio C Hamanoe663a7a2006-01-25 12:37:28[diff] [blame]504<pre><tt>$ git clone --bare -l -s /pub/scm/.../torvalds/linux-2.6.git \
Junio C Hamano38064d52006-01-15 10:13:49[diff] [blame]505 /pub/scm/.../me/subsys-2.6.git</tt></pre>
506</div></div>
507</dd>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]508</dl>
509</div>
510<h2>Author</h2>
511<div class="sectionbody">
512<p>Written by Linus Torvalds &lt;torvalds@osdl.org&gt;</p>
513</div>
514<h2>Documentation</h2>
515<div class="sectionbody">
516<p>Documentation by Junio C Hamano and the git-list &lt;git@vger.kernel.org&gt;.</p>
517</div>
518<h2>GIT</h2>
519<div class="sectionbody">
520<p>Part of the <a href="git.html">git(7)</a> suite</p>
521</div>
522<div id="footer">
523<div id="footer-text">
Junio C Hamano0bbd4672007-02-20 04:52:14[diff] [blame^]524Last updated 20-Feb-2007 04:51:59 UTC
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]525</div>
526</div>
527</body>
528</html>