git-fetch.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-fetch(1)</title>\r
 260 </head>\r
 261 <body>\r
 262 <div id="header">\r
 263 <h1>\r
 264 git-fetch(1) Manual Page\r
 265 </h1>\r
 266 <h2>NAME</h2>\r
 267 <div class="sectionbody">\r
 268 <p>git-fetch -\r
 269    Download objects and a head from another repository.\r
 270 </p>\r
 271 </div>\r
 272 </div>\r
 273 <h2>SYNOPSIS</h2>\r
 274 <div class="sectionbody">\r
 275 <p><em>git-fetch</em> &lt;options&gt; &lt;repository&gt; &lt;refspec&gt;&#8230;</p>\r
 276 </div>\r
 277 <h2>DESCRIPTION</h2>\r
 278 <div class="sectionbody">\r
 279 <p>Fetches named heads or tags from another repository, along with\r
 280 the objects necessary to complete them.</p>\r
 281 <p>The ref names and their object names of fetched refs are stored\r
 282 in <tt>.git/FETCH_HEAD</tt>.  This information is left for a later merge\r
 283 operation done by "git merge".</p>\r
 284 </div>\r
 285 <h2>OPTIONS</h2>\r
 286 <div class="sectionbody">\r
 287 <dl>\r
 288 <dt>\r
 289 -a, --append\r
 290 </dt>\r
 291 <dd>\r
 292 <p>\r
 293         Append ref names and object names of fetched refs to the\r
 294         existing contents of <tt>.git/FETCH_HEAD</tt>.  Without this\r
 295         option old data in <tt>.git/FETCH_HEAD</tt> will be overwritten.\r
 296 </p>\r
 297 </dd>\r
 298 <dt>\r
 299 -f, --force\r
 300 </dt>\r
 301 <dd>\r
 302 <p>\r
 303         When <tt>git-fetch</tt> is used with <tt>&lt;rbranch&gt;:&lt;lbranch&gt;</tt>\r
 304         refspec, it refuses to update the local branch\r
 305         <tt>&lt;lbranch&gt;</tt> unless the remote branch <tt>&lt;rbranch&gt;</tt> it\r
 306         fetches is a descendant of <tt>&lt;lbranch&gt;</tt>.  This option\r
 307         overrides that check.\r
 308 </p>\r
 309 </dd>\r
 310 <dt>\r
 311 -t, --tags\r
 312 </dt>\r
 313 <dd>\r
 314 <p>\r
 315         By default, the git core utilities will not fetch and store\r
 316         tags under the same name as the remote repository;  ask it\r
 317         to do so using <tt>--tags</tt>.  Using this option will bound the\r
 318         list of objects pulled to the remote tags.  Commits in branches\r
 319         beyond the tags will be ignored.\r
 320 </p>\r
 321 </dd>\r
 322 <dt>\r
 323 -u, --update-head-ok\r
 324 </dt>\r
 325 <dd>\r
 326 <p>\r
 327         By default <tt>git-fetch</tt> refuses to update the head which\r
 328         corresponds to the current branch.  This flag disables the\r
 329         check.  Note that fetching into the current branch will not\r
 330         update the index and working directory, so use it with care.\r
 331 </p>\r
 332 </dd>\r
 333 <dt>\r
 334 &lt;repository&gt;\r
 335 </dt>\r
 336 <dd>\r
 337 <p>\r
 338         The "remote" repository that is the source of a fetch\r
 339         or pull operation, or the destination of a push operation.\r
 340         One of the following notations can be used\r
 341         to name the remote repository:\r
 342 </p>\r
 343 <div class="exampleblock">\r
 344 <div class="exampleblock-content">\r
 345 <ul>\r
 346 <li>\r
 347 <p>\r
 348 rsync://host.xz/path/to/repo.git/\r
 349 </p>\r
 350 </li>\r
 351 <li>\r
 352 <p>\r
 353 http://host.xz/path/to/repo.git/\r
 354 </p>\r
 355 </li>\r
 356 <li>\r
 357 <p>\r
 358 https://host.xz/path/to/repo.git/\r
 359 </p>\r
 360 </li>\r
 361 <li>\r
 362 <p>\r
 363 git://host.xz/path/to/repo.git/\r
 364 </p>\r
 365 </li>\r
 366 <li>\r
 367 <p>\r
 368 git://host.xz/~user/path/to/repo.git/\r
 369 </p>\r
 370 </li>\r
 371 <li>\r
 372 <p>\r
 373 ssh://host.xz/path/to/repo.git/\r
 374 </p>\r
 375 </li>\r
 376 <li>\r
 377 <p>\r
 378 ssh://host.xz/~user/path/to/repo.git/\r
 379 </p>\r
 380 </li>\r
 381 <li>\r
 382 <p>\r
 383 ssh://host.xz/~/path/to/repo.git\r
 384 </p>\r
 385 </li>\r
 386 </ul>\r
 387 </div></div>\r
 388 <p>SSH Is the default transport protocol and also supports an\r
 389 scp-like syntax.  Both syntaxes support username expansion,\r
 390 as does the native git protocol. The following three are\r
 391 identical to the last three above, respectively:</p>\r
 392 <div class="exampleblock">\r
 393 <div class="exampleblock-content">\r
 394 <ul>\r
 395 <li>\r
 396 <p>\r
 397 host.xz:/path/to/repo.git/\r
 398 </p>\r
 399 </li>\r
 400 <li>\r
 401 <p>\r
 402 host.xz:~user/path/to/repo.git/\r
 403 </p>\r
 404 </li>\r
 405 <li>\r
 406 <p>\r
 407 host.xz:path/to/repo.git\r
 408 </p>\r
 409 </li>\r
 410 </ul>\r
 411 </div></div>\r
 412 <p>To sync with a local directory, use:</p>\r
 413 <div class="exampleblock">\r
 414 <div class="exampleblock-content">\r
 415 <ul>\r
 416 <li>\r
 417 <p>\r
 418 /path/to/repo.git/\r
 419 </p>\r
 420 </li>\r
 421 </ul>\r
 422 </div></div>\r
 423 <p>In addition to the above, as a short-hand, the name of a\r
 424 file in <tt>$GIT_DIR/remotes</tt> directory can be given; the\r
 425 named file should be in the following format:</p>\r
 426 <div class="literalblock">\r
 427 <div class="content">\r
 428 <pre><tt>URL: one of the above URL format\r
 429 Push: &lt;refspec&gt;\r
 430 Pull: &lt;refspec&gt;</tt></pre>\r
 431 </div></div>\r
 432 <p>When such a short-hand is specified in place of\r
 433 &lt;repository&gt; without &lt;refspec&gt; parameters on the command\r
 434 line, &lt;refspec&gt; specified on <tt>Push:</tt> lines or <tt>Pull:</tt>\r
 435 lines are used for <tt>git-push</tt> and <tt>git-fetch</tt>/<tt>git-pull</tt>,\r
 436 respectively.  Multiple <tt>Push:</tt> and and <tt>Pull:</tt> lines may\r
 437 be specified for additional branch mappings.</p>\r
 438 <p>The name of a file in <tt>$GIT_DIR/branches</tt> directory can be\r
 439 specified as an older notation short-hand; the named\r
 440 file should contain a single line, a URL in one of the\r
 441 above formats, optionally followed by a hash <tt>#</tt> and the\r
 442 name of remote head (URL fragment notation).\r
 443 <tt>$GIT_DIR/branches/&lt;remote&gt;</tt> file that stores a &lt;url&gt;\r
 444 without the fragment is equivalent to have this in the\r
 445 corresponding file in the <tt>$GIT_DIR/remotes/</tt> directory.</p>\r
 446 <div class="literalblock">\r
 447 <div class="content">\r
 448 <pre><tt>URL: &lt;url&gt;\r
 449 Pull: refs/heads/master:&lt;remote&gt;</tt></pre>\r
 450 </div></div>\r
 451 <p>while having <tt>&lt;url&gt;#&lt;head&gt;</tt> is equivalent to</p>\r
 452 <div class="literalblock">\r
 453 <div class="content">\r
 454 <pre><tt>URL: &lt;url&gt;\r
 455 Pull: refs/heads/&lt;head&gt;:&lt;remote&gt;</tt></pre>\r
 456 </div></div>\r
 457 </dd>\r
 458 <dt>\r
 459 &lt;refspec&gt;\r
 460 </dt>\r
 461 <dd>\r
 462 <p>\r
 463         The canonical format of a &lt;refspec&gt; parameter is\r
 464         <tt>+?&lt;src&gt;:&lt;dst&gt;</tt>; that is, an optional plus <tt>+</tt>, followed\r
 465         by the source ref, followed by a colon <tt>:</tt>, followed by\r
 466         the destination ref.\r
 467 </p>\r
 468 <p>When used in <tt>git-push</tt>, the &lt;src&gt; side can be an\r
 469 arbitrary "SHA1 expression" that can be used as an\r
 470 argument to <tt>git-cat-file -t</tt>.  E.g. <tt>master~4</tt> (push\r
 471 four parents before the current master head).</p>\r
 472 <p>For <tt>git-push</tt>, the local ref that matches &lt;src&gt; is used\r
 473 to fast forward the remote ref that matches &lt;dst&gt;.  If\r
 474 the optional plus <tt>+</tt> is used, the remote ref is updated\r
 475 even if it does not result in a fast forward update.</p>\r
 476 <p>For <tt>git-fetch</tt> and <tt>git-pull</tt>, the remote ref that matches &lt;src&gt;\r
 477 is fetched, and if &lt;dst&gt; is not empty string, the local\r
 478 ref that matches it is fast forwarded using &lt;src&gt;.\r
 479 Again, if the optional plus <tt>+</tt> is used, the local ref\r
 480 is updated even if it does not result in a fast forward\r
 481 update.</p>\r
 482 <div class="admonitionblock">\r
 483 <table><tr>\r
 484 <td class="icon">\r
 485 <div class="title">Note</div>\r
 486 </td>\r
 487 <td class="content">If the remote branch from which you want to pull is\r
 488 modified in non-linear ways such as being rewound and\r
 489 rebased frequently, then a pull will attempt a merge with\r
 490 an older version of itself, likely conflict, and fail.\r
 491 It is under these conditions that you would want to use\r
 492 the <tt>+</tt> sign to indicate non-fast-forward updates will\r
 493 be needed.  There is currently no easy way to determine\r
 494 or declare that a branch will be made available in a\r
 495 repository with this behavior; the pulling user simply\r
 496 must know this is the expected usage pattern for a branch.</td>\r
 497 </tr></table>\r
 498 </div>\r
 499 <div class="admonitionblock">\r
 500 <table><tr>\r
 501 <td class="icon">\r
 502 <div class="title">Note</div>\r
 503 </td>\r
 504 <td class="content">You never do your own development on branches that appear\r
 505 on the right hand side of a &lt;refspec&gt; colon on <tt>Pull:</tt> lines;\r
 506 they are to be updated by <tt>git-fetch</tt>.  If you intend to do\r
 507 development derived from a remote branch <tt>B</tt>, have a <tt>Pull:</tt>\r
 508 line to track it (i.e. <tt>Pull: B:remote-B</tt>), and have a separate\r
 509 branch <tt>my-B</tt> to do your development on top of it.  The latter\r
 510 is created by <tt>git branch my-B remote-B</tt> (or its equivalent <tt>git\r
 511 checkout -b my-B remote-B</tt>).  Run <tt>git fetch</tt> to keep track of\r
 512 the progress of the remote side, and when you see something new\r
 513 on the remote branch, merge it into your development branch with\r
 514 <tt>git pull . remote-B</tt>, while you are on <tt>my-B</tt> branch.\r
 515 The common <tt>Pull: master:origin</tt> mapping of a remote <tt>master</tt>\r
 516 branch to a local <tt>origin</tt> branch, which is then merged to a\r
 517 local development branch, again typically named <tt>master</tt>, is made\r
 518 when you run <tt>git clone</tt> for you to follow this pattern.</td>\r
 519 </tr></table>\r
 520 </div>\r
 521 <div class="admonitionblock">\r
 522 <table><tr>\r
 523 <td class="icon">\r
 524 <div class="title">Note</div>\r
 525 </td>\r
 526 <td class="content">There is a difference between listing multiple &lt;refspec&gt;\r
 527 directly on <tt>git-pull</tt> command line and having multiple\r
 528 <tt>Pull:</tt> &lt;refspec&gt; lines for a &lt;repository&gt; and running\r
 529 <tt>git-pull</tt> command without any explicit &lt;refspec&gt; parameters.\r
 530 &lt;refspec&gt; listed explicitly on the command line are always\r
 531 merged into the current branch after fetching.  In other words,\r
 532 if you list more than one remote refs, you would be making\r
 533 an Octopus.  While <tt>git-pull</tt> run without any explicit &lt;refspec&gt;\r
 534 parameter takes default &lt;refspec&gt;s from <tt>Pull:</tt> lines, it\r
 535 merges only the first &lt;refspec&gt; found into the current branch,\r
 536 after fetching all the remote refs.  This is because making an\r
 537 Octopus from remote refs is rarely done, while keeping track\r
 538 of multiple remote heads in one-go by fetching more than one\r
 539 is often useful.</td>\r
 540 </tr></table>\r
 541 </div>\r
 542 <p>Some short-cut notations are also supported.</p>\r
 543 <ul>\r
 544 <li>\r
 545 <p>\r
 546 For backward compatibility, <tt>tag</tt> is almost ignored;\r
 547   it just makes the following parameter &lt;tag&gt; to mean a\r
 548   refspec <tt>refs/tags/&lt;tag&gt;:refs/tags/&lt;tag&gt;</tt>.\r
 549 </p>\r
 550 </li>\r
 551 <li>\r
 552 <p>\r
 553 A parameter &lt;ref&gt; without a colon is equivalent to\r
 554   &lt;ref&gt;: when pulling/fetching, and &lt;ref&gt;<tt>:</tt>&lt;ref&gt; when\r
 555   pushing.  That is, do not store it locally if\r
 556   fetching, and update the same name if pushing.\r
 557 </p>\r
 558 </li>\r
 559 </ul>\r
 560 </dd>\r
 561 </dl>\r
 562 </div>\r
 563 <h2>SEE ALSO</h2>\r
 564 <div class="sectionbody">\r
 565 <p><a href="git-pull.html">git-pull(1)</a></p>\r
 566 </div>\r
 567 <h2>Author</h2>\r
 568 <div class="sectionbody">\r
 569 <p>Written by Linus Torvalds &lt;torvalds@osdl.org&gt; and\r
 570 Junio C Hamano &lt;junkio@cox.net&gt;</p>\r
 571 </div>\r
 572 <h2>Documentation</h2>\r
 573 <div class="sectionbody">\r
 574 <p>Documentation by David Greaves, Junio C Hamano and the git-list &lt;git@vger.kernel.org&gt;.</p>\r
 575 </div>\r
 576 <h2>GIT</h2>\r
 577 <div class="sectionbody">\r
 578 <p>Part of the <a href="git.html">git(7)</a> suite</p>\r
 579 </div>\r
 580 <div id="footer">\r
 581 <div id="footer-text">\r
 582 Last updated 27-Dec-2005 00:16:06 PDT\r
 583 </div>\r
 584 </div>\r
 585 </body>\r
 586 </html>\r