Autogenerated HTML docs for v1.1.6-g8233
[git.git] / git-push.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"\r
2     "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">\r
4 <head>\r
5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />\r
6 <meta name="generator" content="AsciiDoc 7.0.1" />\r
7 <style type="text/css">\r
8 /* Debug borders */\r
9 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {\r
10 /*\r
11   border: 1px solid red;\r
12 */\r
13 }\r
14 \r
15 body {\r
16   margin: 1em 5% 1em 5%;\r
17 }\r
18 \r
19 a { color: blue; }\r
20 a:visited { color: fuchsia; }\r
21 \r
22 em {\r
23   font-style: italic;\r
24 }\r
25 \r
26 strong {\r
27   font-weight: bold;\r
28 }\r
29 \r
30 tt {\r
31   color: navy;\r
32 }\r
33 \r
34 h1, h2, h3, h4, h5, h6 {\r
35   color: #527bbd;\r
36   font-family: sans-serif;\r
37   margin-top: 1.2em;\r
38   margin-bottom: 0.5em;\r
39   line-height: 1.3;\r
40 }\r
41 \r
42 h1 {\r
43   border-bottom: 2px solid silver;\r
44 }\r
45 h2 {\r
46   border-bottom: 2px solid silver;\r
47   padding-top: 0.5em;\r
48 }\r
49 \r
50 div.sectionbody {\r
51   font-family: serif;\r
52   margin-left: 0;\r
53 }\r
54 \r
55 hr {\r
56   border: 1px solid silver;\r
57 }\r
58 \r
59 p {\r
60   margin-top: 0.5em;\r
61   margin-bottom: 0.5em;\r
62 }\r
63 \r
64 pre {\r
65   padding: 0;\r
66   margin: 0;\r
67 }\r
68 \r
69 span#author {\r
70   color: #527bbd;\r
71   font-family: sans-serif;\r
72   font-weight: bold;\r
73   font-size: 1.2em;\r
74 }\r
75 span#email {\r
76 }\r
77 span#revision {\r
78   font-family: sans-serif;\r
79 }\r
80 \r
81 div#footer {\r
82   font-family: sans-serif;\r
83   font-size: small;\r
84   border-top: 2px solid silver;\r
85   padding-top: 0.5em;\r
86   margin-top: 4.0em;\r
87 }\r
88 div#footer-text {\r
89   float: left;\r
90   padding-bottom: 0.5em;\r
91 }\r
92 div#footer-badges {\r
93   float: right;\r
94   padding-bottom: 0.5em;\r
95 }\r
96 \r
97 div#preamble,\r
98 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,\r
99 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,\r
100 div.admonitionblock {\r
101   margin-right: 10%;\r
102   margin-top: 1.5em;\r
103   margin-bottom: 1.5em;\r
104 }\r
105 div.admonitionblock {\r
106   margin-top: 2.5em;\r
107   margin-bottom: 2.5em;\r
108 }\r
109 \r
110 div.content { /* Block element content. */\r
111   padding: 0;\r
112 }\r
113 \r
114 /* Block element titles. */\r
115 div.title, caption.title {\r
116   font-family: sans-serif;\r
117   font-weight: bold;\r
118   text-align: left;\r
119   margin-top: 1.0em;\r
120   margin-bottom: 0.5em;\r
121 }\r
122 div.title + * {\r
123   margin-top: 0;\r
124 }\r
125 \r
126 td div.title:first-child {\r
127   margin-top: 0.0em;\r
128 }\r
129 div.content div.title:first-child {\r
130   margin-top: 0.0em;\r
131 }\r
132 div.content + div.title {\r
133   margin-top: 0.0em;\r
134 }\r
135 \r
136 div.sidebarblock > div.content {\r
137   background: #ffffee;\r
138   border: 1px solid silver;\r
139   padding: 0.5em;\r
140 }\r
141 \r
142 div.listingblock > div.content {\r
143   border: 1px solid silver;\r
144   background: #f4f4f4;\r
145   padding: 0.5em;\r
146 }\r
147 \r
148 div.quoteblock > div.content {\r
149   padding-left: 2.0em;\r
150 }\r
151 div.quoteblock .attribution {\r
152   text-align: right;\r
153 }\r
154 \r
155 div.admonitionblock .icon {\r
156   vertical-align: top;\r
157   font-size: 1.1em;\r
158   font-weight: bold;\r
159   text-decoration: underline;\r
160   color: #527bbd;\r
161   padding-right: 0.5em;\r
162 }\r
163 div.admonitionblock td.content {\r
164   padding-left: 0.5em;\r
165   border-left: 2px solid silver;\r
166 }\r
167 \r
168 div.exampleblock > div.content {\r
169   border-left: 2px solid silver;\r
170   padding: 0.5em;\r
171 }\r
172 \r
173 div.verseblock div.content {\r
174   white-space: pre;\r
175 }\r
176 \r
177 div.imageblock div.content { padding-left: 0; }\r
178 div.imageblock img { border: 1px solid silver; }\r
179 span.image img { border-style: none; }\r
180 \r
181 dl {\r
182   margin-top: 0.8em;\r
183   margin-bottom: 0.8em;\r
184 }\r
185 dt {\r
186   margin-top: 0.5em;\r
187   margin-bottom: 0;\r
188   font-style: italic;\r
189 }\r
190 dd > *:first-child {\r
191   margin-top: 0;\r
192 }\r
193 \r
194 ul, ol {\r
195     list-style-position: outside;\r
196 }\r
197 ol.olist2 {\r
198   list-style-type: lower-alpha;\r
199 }\r
200 \r
201 div.tableblock > table {\r
202   border-color: #527bbd;\r
203   border-width: 3px;\r
204 }\r
205 thead {\r
206   font-family: sans-serif;\r
207   font-weight: bold;\r
208 }\r
209 tfoot {\r
210   font-weight: bold;\r
211 }\r
212 \r
213 div.hlist {\r
214   margin-top: 0.8em;\r
215   margin-bottom: 0.8em;\r
216 }\r
217 td.hlist1 {\r
218   vertical-align: top;\r
219   font-style: italic;\r
220   padding-right: 0.8em;\r
221 }\r
222 td.hlist2 {\r
223   vertical-align: top;\r
224 }\r
225 \r
226 @media print {\r
227   div#footer-badges { display: none; }\r
228 }\r
229 include::./stylesheets/xhtml11-manpage.css[]\r
230 /* Workarounds for IE6's broken and incomplete CSS2. */\r
231 \r
232 div.sidebar-content {\r
233   background: #ffffee;\r
234   border: 1px solid silver;\r
235   padding: 0.5em;\r
236 }\r
237 div.sidebar-title, div.image-title {\r
238   font-family: sans-serif;\r
239   font-weight: bold;\r
240   margin-top: 0.0em;\r
241   margin-bottom: 0.5em;\r
242 }\r
243 \r
244 div.listingblock div.content {\r
245   border: 1px solid silver;\r
246   background: #f4f4f4;\r
247   padding: 0.5em;\r
248 }\r
249 \r
250 div.quoteblock-content {\r
251   padding-left: 2.0em;\r
252 }\r
253 \r
254 div.exampleblock-content {\r
255   border-left: 2px solid silver;\r
256   padding-left: 0.5em;\r
257 }\r
258 </style>\r
259 <title>git-push(1)</title>\r
260 </head>\r
261 <body>\r
262 <div id="header">\r
263 <h1>\r
264 git-push(1) Manual Page\r
265 </h1>\r
266 <h2>NAME</h2>\r
267 <div class="sectionbody">\r
268 <p>git-push -\r
269    Update remote refs along with associated objects.\r
270 </p>\r
271 </div>\r
272 </div>\r
273 <h2>SYNOPSIS</h2>\r
274 <div class="sectionbody">\r
275 <p><em>git-push</em> [--all] [--tags] [--force] &lt;repository&gt; &lt;refspec&gt;&#8230;</p>\r
276 </div>\r
277 <h2>DESCRIPTION</h2>\r
278 <div class="sectionbody">\r
279 <p>Updates remote refs using local refs, while sending objects\r
280 necessary to complete the given refs.</p>\r
281 <p>You can make "interesting" things to happen on the repository\r
282 every time you push into it, by setting up <em>hooks</em> there.  See\r
283 documentation for <a href="git-receive-pack.html">git-receive-pack(1)</a>.</p>\r
284 </div>\r
285 <h2>OPTIONS</h2>\r
286 <div class="sectionbody">\r
287 <dl>\r
288 <dt>\r
289 &lt;repository&gt;\r
290 </dt>\r
291 <dd>\r
292 <p>\r
293         The "remote" repository that is the source of a fetch\r
294         or pull operation, or the destination of a push operation.\r
295         One of the following notations can be used\r
296         to name the remote repository:\r
297 </p>\r
298 <div class="exampleblock">\r
299 <div class="exampleblock-content">\r
300 <ul>\r
301 <li>\r
302 <p>\r
303 rsync://host.xz/path/to/repo.git/\r
304 </p>\r
305 </li>\r
306 <li>\r
307 <p>\r
308 http://host.xz/path/to/repo.git/\r
309 </p>\r
310 </li>\r
311 <li>\r
312 <p>\r
313 https://host.xz/path/to/repo.git/\r
314 </p>\r
315 </li>\r
316 <li>\r
317 <p>\r
318 git://host.xz/path/to/repo.git/\r
319 </p>\r
320 </li>\r
321 <li>\r
322 <p>\r
323 git://host.xz/~user/path/to/repo.git/\r
324 </p>\r
325 </li>\r
326 <li>\r
327 <p>\r
328 ssh://host.xz/path/to/repo.git/\r
329 </p>\r
330 </li>\r
331 <li>\r
332 <p>\r
333 ssh://host.xz/~user/path/to/repo.git/\r
334 </p>\r
335 </li>\r
336 <li>\r
337 <p>\r
338 ssh://host.xz/~/path/to/repo.git\r
339 </p>\r
340 </li>\r
341 </ul>\r
342 </div></div>\r
343 <p>SSH Is the default transport protocol and also supports an\r
344 scp-like syntax.  Both syntaxes support username expansion,\r
345 as does the native git protocol. The following three are\r
346 identical to the last three above, respectively:</p>\r
347 <div class="exampleblock">\r
348 <div class="exampleblock-content">\r
349 <ul>\r
350 <li>\r
351 <p>\r
352 host.xz:/path/to/repo.git/\r
353 </p>\r
354 </li>\r
355 <li>\r
356 <p>\r
357 host.xz:~user/path/to/repo.git/\r
358 </p>\r
359 </li>\r
360 <li>\r
361 <p>\r
362 host.xz:path/to/repo.git\r
363 </p>\r
364 </li>\r
365 </ul>\r
366 </div></div>\r
367 <p>To sync with a local directory, use:</p>\r
368 <div class="exampleblock">\r
369 <div class="exampleblock-content">\r
370 <ul>\r
371 <li>\r
372 <p>\r
373 /path/to/repo.git/\r
374 </p>\r
375 </li>\r
376 </ul>\r
377 </div></div>\r
378 <p>In addition to the above, as a short-hand, the name of a\r
379 file in <tt>$GIT_DIR/remotes</tt> directory can be given; the\r
380 named file should be in the following format:</p>\r
381 <div class="literalblock">\r
382 <div class="content">\r
383 <pre><tt>URL: one of the above URL format\r
384 Push: &lt;refspec&gt;\r
385 Pull: &lt;refspec&gt;</tt></pre>\r
386 </div></div>\r
387 <p>When such a short-hand is specified in place of\r
388 &lt;repository&gt; without &lt;refspec&gt; parameters on the command\r
389 line, &lt;refspec&gt; specified on <tt>Push:</tt> lines or <tt>Pull:</tt>\r
390 lines are used for <tt>git-push</tt> and <tt>git-fetch</tt>/<tt>git-pull</tt>,\r
391 respectively.  Multiple <tt>Push:</tt> and and <tt>Pull:</tt> lines may\r
392 be specified for additional branch mappings.</p>\r
393 <p>The name of a file in <tt>$GIT_DIR/branches</tt> directory can be\r
394 specified as an older notation short-hand; the named\r
395 file should contain a single line, a URL in one of the\r
396 above formats, optionally followed by a hash <tt>#</tt> and the\r
397 name of remote head (URL fragment notation).\r
398 <tt>$GIT_DIR/branches/&lt;remote&gt;</tt> file that stores a &lt;url&gt;\r
399 without the fragment is equivalent to have this in the\r
400 corresponding file in the <tt>$GIT_DIR/remotes/</tt> directory.</p>\r
401 <div class="literalblock">\r
402 <div class="content">\r
403 <pre><tt>URL: &lt;url&gt;\r
404 Pull: refs/heads/master:&lt;remote&gt;</tt></pre>\r
405 </div></div>\r
406 <p>while having <tt>&lt;url&gt;#&lt;head&gt;</tt> is equivalent to</p>\r
407 <div class="literalblock">\r
408 <div class="content">\r
409 <pre><tt>URL: &lt;url&gt;\r
410 Pull: refs/heads/&lt;head&gt;:&lt;remote&gt;</tt></pre>\r
411 </div></div>\r
412 </dd>\r
413 <dt>\r
414 &lt;refspec&gt;\r
415 </dt>\r
416 <dd>\r
417 <p>\r
418         The canonical format of a &lt;refspec&gt; parameter is\r
419         <tt>+?&lt;src&gt;:&lt;dst&gt;</tt>; that is, an optional plus <tt>+</tt>, followed\r
420         by the source ref, followed by a colon <tt>:</tt>, followed by\r
421         the destination ref.\r
422 </p>\r
423 <p>When used in <tt>git-push</tt>, the &lt;src&gt; side can be an\r
424 arbitrary "SHA1 expression" that can be used as an\r
425 argument to <tt>git-cat-file -t</tt>.  E.g. <tt>master~4</tt> (push\r
426 four parents before the current master head).</p>\r
427 <p>For <tt>git-push</tt>, the local ref that matches &lt;src&gt; is used\r
428 to fast forward the remote ref that matches &lt;dst&gt;.  If\r
429 the optional plus <tt>+</tt> is used, the remote ref is updated\r
430 even if it does not result in a fast forward update.</p>\r
431 <p>For <tt>git-fetch</tt> and <tt>git-pull</tt>, the remote ref that matches &lt;src&gt;\r
432 is fetched, and if &lt;dst&gt; is not empty string, the local\r
433 ref that matches it is fast forwarded using &lt;src&gt;.\r
434 Again, if the optional plus <tt>+</tt> is used, the local ref\r
435 is updated even if it does not result in a fast forward\r
436 update.</p>\r
437 <div class="admonitionblock">\r
438 <table><tr>\r
439 <td class="icon">\r
440 <div class="title">Note</div>\r
441 </td>\r
442 <td class="content">If the remote branch from which you want to pull is\r
443 modified in non-linear ways such as being rewound and\r
444 rebased frequently, then a pull will attempt a merge with\r
445 an older version of itself, likely conflict, and fail.\r
446 It is under these conditions that you would want to use\r
447 the <tt>+</tt> sign to indicate non-fast-forward updates will\r
448 be needed.  There is currently no easy way to determine\r
449 or declare that a branch will be made available in a\r
450 repository with this behavior; the pulling user simply\r
451 must know this is the expected usage pattern for a branch.</td>\r
452 </tr></table>\r
453 </div>\r
454 <div class="admonitionblock">\r
455 <table><tr>\r
456 <td class="icon">\r
457 <div class="title">Note</div>\r
458 </td>\r
459 <td class="content">You never do your own development on branches that appear\r
460 on the right hand side of a &lt;refspec&gt; colon on <tt>Pull:</tt> lines;\r
461 they are to be updated by <tt>git-fetch</tt>.  If you intend to do\r
462 development derived from a remote branch <tt>B</tt>, have a <tt>Pull:</tt>\r
463 line to track it (i.e. <tt>Pull: B:remote-B</tt>), and have a separate\r
464 branch <tt>my-B</tt> to do your development on top of it.  The latter\r
465 is created by <tt>git branch my-B remote-B</tt> (or its equivalent <tt>git\r
466 checkout -b my-B remote-B</tt>).  Run <tt>git fetch</tt> to keep track of\r
467 the progress of the remote side, and when you see something new\r
468 on the remote branch, merge it into your development branch with\r
469 <tt>git pull . remote-B</tt>, while you are on <tt>my-B</tt> branch.\r
470 The common <tt>Pull: master:origin</tt> mapping of a remote <tt>master</tt>\r
471 branch to a local <tt>origin</tt> branch, which is then merged to a\r
472 local development branch, again typically named <tt>master</tt>, is made\r
473 when you run <tt>git clone</tt> for you to follow this pattern.</td>\r
474 </tr></table>\r
475 </div>\r
476 <div class="admonitionblock">\r
477 <table><tr>\r
478 <td class="icon">\r
479 <div class="title">Note</div>\r
480 </td>\r
481 <td class="content">There is a difference between listing multiple &lt;refspec&gt;\r
482 directly on <tt>git-pull</tt> command line and having multiple\r
483 <tt>Pull:</tt> &lt;refspec&gt; lines for a &lt;repository&gt; and running\r
484 <tt>git-pull</tt> command without any explicit &lt;refspec&gt; parameters.\r
485 &lt;refspec&gt; listed explicitly on the command line are always\r
486 merged into the current branch after fetching.  In other words,\r
487 if you list more than one remote refs, you would be making\r
488 an Octopus.  While <tt>git-pull</tt> run without any explicit &lt;refspec&gt;\r
489 parameter takes default &lt;refspec&gt;s from <tt>Pull:</tt> lines, it\r
490 merges only the first &lt;refspec&gt; found into the current branch,\r
491 after fetching all the remote refs.  This is because making an\r
492 Octopus from remote refs is rarely done, while keeping track\r
493 of multiple remote heads in one-go by fetching more than one\r
494 is often useful.</td>\r
495 </tr></table>\r
496 </div>\r
497 <p>Some short-cut notations are also supported.</p>\r
498 <ul>\r
499 <li>\r
500 <p>\r
501 <tt>tag &lt;tag&gt;</tt> means the same as <tt>refs/tags/&lt;tag&gt;:refs/tags/&lt;tag&gt;</tt>;\r
502   used with pull or fetch, it requests fetching everything up to\r
503   the given tag.\r
504 </p>\r
505 </li>\r
506 <li>\r
507 <p>\r
508 A parameter &lt;ref&gt; without a colon is equivalent to\r
509   &lt;ref&gt;: when pulling/fetching, and &lt;ref&gt;<tt>:</tt>&lt;ref&gt; when\r
510   pushing.  That is, do not store it locally if\r
511   fetching, and update the same name if pushing.\r
512 </p>\r
513 </li>\r
514 </ul>\r
515 </dd>\r
516 <dt>\r
517 --all\r
518 </dt>\r
519 <dd>\r
520 <p>\r
521         Instead of naming each ref to push, specifies all refs\r
522         to be pushed.\r
523 </p>\r
524 </dd>\r
525 <dt>\r
526 --tags\r
527 </dt>\r
528 <dd>\r
529 <p>\r
530         All refs under <tt>$GIT_DIR/refs/tags</tt> are pushed, in\r
531         addition to refspecs explicitly listed on the command\r
532         line.\r
533 </p>\r
534 </dd>\r
535 <dt>\r
536 -f, --force\r
537 </dt>\r
538 <dd>\r
539 <p>\r
540         Usually, the command refuses to update a remote ref that is\r
541         not a descendent of the local ref used to overwrite it.\r
542         This flag disables the check.  This can cause the\r
543         remote repository to lose commits; use it with care.\r
544 </p>\r
545 </dd>\r
546 </dl>\r
547 </div>\r
548 <h2>Author</h2>\r
549 <div class="sectionbody">\r
550 <p>Written by Junio C Hamano &lt;junkio@cox.net&gt;</p>\r
551 </div>\r
552 <h2>Documentation</h2>\r
553 <div class="sectionbody">\r
554 <p>Documentation by Junio C Hamano and the git-list &lt;git@vger.kernel.org&gt;.</p>\r
555 </div>\r
556 <h2>GIT</h2>\r
557 <div class="sectionbody">\r
558 <p>Part of the <a href="git.html">git(7)</a> suite</p>\r
559 </div>\r
560 <div id="footer">\r
561 <div id="footer-text">\r
562 Last updated 29-Jan-2006 20:18:18 PDT\r
563 </div>\r
564 </div>\r
565 </body>\r
566 </html>\r