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