doc/source/en/TortoiseGit/git_doc/git-pack-objects.xml

   1 <?xml version="1.0" encoding="UTF-8"?>\r
   2 <!DOCTYPE sect2 SYSTEM "../../../dtd/dblite.dtd">\r
   3 \r
   4 <sect2 lang="en" id="git-pack-objects(1)">\r
   5     <title>git-pack-objects(1)</title>\r
   6 <indexterm>\r
   7 <primary>git-pack-objects(1)</primary>\r
   8 </indexterm>\r
   9 <simplesect id="git-pack-objects(1)__name">\r
  10 <title>NAME</title>\r
  11 <simpara>git-pack-objects - Create a packed archive of objects</simpara>\r
  12 </simplesect>\r
  13 <simplesect id="git-pack-objects(1)__synopsis">\r
  14 <title>SYNOPSIS</title>\r
  15 <blockquote>\r
  16 <literallayout><emphasis>git pack-objects</emphasis> [-q | --progress | --all-progress] [--all-progress-implied]\r
  17         [--no-reuse-delta] [--delta-base-offset] [--non-empty]\r
  18         [--local] [--incremental] [--window=&lt;n&gt;] [--depth=&lt;n&gt;]\r
  19         [--revs [--unpacked | --all]] [--keep-pack=&lt;pack-name&gt;]\r
  20         [--stdout [--filter=&lt;filter-spec&gt;] | base-name]\r
  21         [--shallow] [--keep-true-parents] [--[no-]sparse] &lt; object-list</literallayout>\r
  22 </blockquote>\r
  23 </simplesect>\r
  24 <simplesect id="git-pack-objects(1)__description">\r
  25 <title>DESCRIPTION</title>\r
  26 <simpara>Reads list of objects from the standard input, and writes either one or\r
  27 more packed archives with the specified base-name to disk, or a packed\r
  28 archive to the standard output.</simpara>\r
  29 <simpara>A packed archive is an efficient way to transfer a set of objects\r
  30 between two repositories as well as an access efficient archival\r
  31 format.  In a packed archive, an object is either stored as a\r
  32 compressed whole or as a difference from some other object.\r
  33 The latter is often called a delta.</simpara>\r
  34 <simpara>The packed archive format (.pack) is designed to be self-contained\r
  35 so that it can be unpacked without any further information. Therefore,\r
  36 each object that a delta depends upon must be present within the pack.</simpara>\r
  37 <simpara>A pack index file (.idx) is generated for fast, random access to the\r
  38 objects in the pack. Placing both the index file (.idx) and the packed\r
  39 archive (.pack) in the pack/ subdirectory of $GIT_OBJECT_DIRECTORY (or\r
  40 any of the directories on $GIT_ALTERNATE_OBJECT_DIRECTORIES)\r
  41 enables Git to read from the pack archive.</simpara>\r
  42 <simpara>The <emphasis>git unpack-objects</emphasis> command can read the packed archive and\r
  43 expand the objects contained in the pack into "one-file\r
  44 one-object" format; this is typically done by the smart-pull\r
  45 commands when a pack is created on-the-fly for efficient network\r
  46 transport by their peers.</simpara>\r
  47 </simplesect>\r
  48 <simplesect id="git-pack-objects(1)__options">\r
  49 <title>OPTIONS</title>\r
  50 <variablelist>\r
  51 <varlistentry>\r
  52 <term>\r
  53 base-name\r
  54 </term>\r
  55 <listitem>\r
  56 <simpara>\r
  57         Write into pairs of files (.pack and .idx), using\r
  58         &lt;base-name&gt; to determine the name of the created file.\r
  59         When this option is used, the two files in a pair are written in\r
  60         &lt;base-name&gt;-&lt;SHA-1&gt;.{pack,idx} files.  &lt;SHA-1&gt; is a hash\r
  61         based on the pack content and is written to the standard\r
  62         output of the command.\r
  63 </simpara>\r
  64 </listitem>\r
  65 </varlistentry>\r
  66 <varlistentry>\r
  67 <term>\r
  68 --stdout\r
  69 </term>\r
  70 <listitem>\r
  71 <simpara>\r
  72         Write the pack contents (what would have been written to\r
  73         .pack file) out to the standard output.\r
  74 </simpara>\r
  75 </listitem>\r
  76 </varlistentry>\r
  77 <varlistentry>\r
  78 <term>\r
  79 --revs\r
  80 </term>\r
  81 <listitem>\r
  82 <simpara>\r
  83         Read the revision arguments from the standard input, instead of\r
  84         individual object names.  The revision arguments are processed\r
  85         the same way as <emphasis>git rev-list</emphasis> with the <emphasis>--objects</emphasis> flag\r
  86         uses its <emphasis>commit</emphasis> arguments to build the list of objects it\r
  87         outputs.  The objects on the resulting list are packed.\r
  88         Besides revisions, <emphasis>--not</emphasis> or <emphasis>--shallow &lt;SHA-1&gt;</emphasis> lines are\r
  89         also accepted.\r
  90 </simpara>\r
  91 </listitem>\r
  92 </varlistentry>\r
  93 <varlistentry>\r
  94 <term>\r
  95 --unpacked\r
  96 </term>\r
  97 <listitem>\r
  98 <simpara>\r
  99         This implies <emphasis>--revs</emphasis>.  When processing the list of\r
 100         revision arguments read from the standard input, limit\r
 101         the objects packed to those that are not already packed.\r
 102 </simpara>\r
 103 </listitem>\r
 104 </varlistentry>\r
 105 <varlistentry>\r
 106 <term>\r
 107 --all\r
 108 </term>\r
 109 <listitem>\r
 110 <simpara>\r
 111         This implies <emphasis>--revs</emphasis>.  In addition to the list of\r
 112         revision arguments read from the standard input, pretend\r
 113         as if all refs under <emphasis>refs/</emphasis> are specified to be\r
 114         included.\r
 115 </simpara>\r
 116 </listitem>\r
 117 </varlistentry>\r
 118 <varlistentry>\r
 119 <term>\r
 120 --include-tag\r
 121 </term>\r
 122 <listitem>\r
 123 <simpara>\r
 124         Include unasked-for annotated tags if the object they\r
 125         reference was included in the resulting packfile.  This\r
 126         can be useful to send new tags to native Git clients.\r
 127 </simpara>\r
 128 </listitem>\r
 129 </varlistentry>\r
 130 <varlistentry>\r
 131 <term>\r
 132 --window=&lt;n&gt;\r
 133 </term>\r
 134 <term>\r
 135 --depth=&lt;n&gt;\r
 136 </term>\r
 137 <listitem>\r
 138 <simpara>\r
 139         These two options affect how the objects contained in\r
 140         the pack are stored using delta compression.  The\r
 141         objects are first internally sorted by type, size and\r
 142         optionally names and compared against the other objects\r
 143         within --window to see if using delta compression saves\r
 144         space.  --depth limits the maximum delta depth; making\r
 145         it too deep affects the performance on the unpacker\r
 146         side, because delta data needs to be applied that many\r
 147         times to get to the necessary object.\r
 148 </simpara>\r
 149 <simpara>The default value for --window is 10 and --depth is 50. The maximum\r
 150 depth is 4095.</simpara>\r
 151 </listitem>\r
 152 </varlistentry>\r
 153 <varlistentry>\r
 154 <term>\r
 155 --window-memory=&lt;n&gt;\r
 156 </term>\r
 157 <listitem>\r
 158 <simpara>\r
 159         This option provides an additional limit on top of <emphasis>--window</emphasis>;\r
 160         the window size will dynamically scale down so as to not take\r
 161         up more than <emphasis>&lt;n&gt;</emphasis> bytes in memory.  This is useful in\r
 162         repositories with a mix of large and small objects to not run\r
 163         out of memory with a large window, but still be able to take\r
 164         advantage of the large window for the smaller objects.  The\r
 165         size can be suffixed with "k", "m", or "g".\r
 166         <emphasis>--window-memory=0</emphasis> makes memory usage unlimited.  The default\r
 167         is taken from the <emphasis>pack.windowMemory</emphasis> configuration variable.\r
 168 </simpara>\r
 169 </listitem>\r
 170 </varlistentry>\r
 171 <varlistentry>\r
 172 <term>\r
 173 --max-pack-size=&lt;n&gt;\r
 174 </term>\r
 175 <listitem>\r
 176 <simpara>\r
 177         In unusual scenarios, you may not be able to create files\r
 178         larger than a certain size on your filesystem, and this option\r
 179         can be used to tell the command to split the output packfile\r
 180         into multiple independent packfiles, each not larger than the\r
 181         given size. The size can be suffixed with\r
 182         "k", "m", or "g". The minimum size allowed is limited to 1 MiB.\r
 183         This option\r
 184         prevents the creation of a bitmap index.\r
 185         The default is unlimited, unless the config variable\r
 186         <emphasis>pack.packSizeLimit</emphasis> is set.\r
 187 </simpara>\r
 188 </listitem>\r
 189 </varlistentry>\r
 190 <varlistentry>\r
 191 <term>\r
 192 --honor-pack-keep\r
 193 </term>\r
 194 <listitem>\r
 195 <simpara>\r
 196         This flag causes an object already in a local pack that\r
 197         has a .keep file to be ignored, even if it would have\r
 198         otherwise been packed.\r
 199 </simpara>\r
 200 </listitem>\r
 201 </varlistentry>\r
 202 <varlistentry>\r
 203 <term>\r
 204 --keep-pack=&lt;pack-name&gt;\r
 205 </term>\r
 206 <listitem>\r
 207 <simpara>\r
 208         This flag causes an object already in the given pack to be\r
 209         ignored, even if it would have otherwise been\r
 210         packed. <emphasis>&lt;pack-name&gt;</emphasis> is the pack file name without\r
 211         leading directory (e.g. <emphasis>pack-123.pack</emphasis>). The option could be\r
 212         specified multiple times to keep multiple packs.\r
 213 </simpara>\r
 214 </listitem>\r
 215 </varlistentry>\r
 216 <varlistentry>\r
 217 <term>\r
 218 --incremental\r
 219 </term>\r
 220 <listitem>\r
 221 <simpara>\r
 222         This flag causes an object already in a pack to be ignored\r
 223         even if it would have otherwise been packed.\r
 224 </simpara>\r
 225 </listitem>\r
 226 </varlistentry>\r
 227 <varlistentry>\r
 228 <term>\r
 229 --local\r
 230 </term>\r
 231 <listitem>\r
 232 <simpara>\r
 233         This flag causes an object that is borrowed from an alternate\r
 234         object store to be ignored even if it would have otherwise been\r
 235         packed.\r
 236 </simpara>\r
 237 </listitem>\r
 238 </varlistentry>\r
 239 <varlistentry>\r
 240 <term>\r
 241 --non-empty\r
 242 </term>\r
 243 <listitem>\r
 244 <simpara>\r
 245         Only create a packed archive if it would contain at\r
 246         least one object.\r
 247 </simpara>\r
 248 </listitem>\r
 249 </varlistentry>\r
 250 <varlistentry>\r
 251 <term>\r
 252 --progress\r
 253 </term>\r
 254 <listitem>\r
 255 <simpara>\r
 256         Progress status is reported on the standard error stream\r
 257         by default when it is attached to a terminal, unless -q\r
 258         is specified. This flag forces progress status even if\r
 259         the standard error stream is not directed to a terminal.\r
 260 </simpara>\r
 261 </listitem>\r
 262 </varlistentry>\r
 263 <varlistentry>\r
 264 <term>\r
 265 --all-progress\r
 266 </term>\r
 267 <listitem>\r
 268 <simpara>\r
 269         When --stdout is specified then progress report is\r
 270         displayed during the object count and compression phases\r
 271         but inhibited during the write-out phase. The reason is\r
 272         that in some cases the output stream is directly linked\r
 273         to another command which may wish to display progress\r
 274         status of its own as it processes incoming pack data.\r
 275         This flag is like --progress except that it forces progress\r
 276         report for the write-out phase as well even if --stdout is\r
 277         used.\r
 278 </simpara>\r
 279 </listitem>\r
 280 </varlistentry>\r
 281 <varlistentry>\r
 282 <term>\r
 283 --all-progress-implied\r
 284 </term>\r
 285 <listitem>\r
 286 <simpara>\r
 287         This is used to imply --all-progress whenever progress display\r
 288         is activated.  Unlike --all-progress this flag doesn't actually\r
 289         force any progress display by itself.\r
 290 </simpara>\r
 291 </listitem>\r
 292 </varlistentry>\r
 293 <varlistentry>\r
 294 <term>\r
 295 -q\r
 296 </term>\r
 297 <listitem>\r
 298 <simpara>\r
 299         This flag makes the command not to report its progress\r
 300         on the standard error stream.\r
 301 </simpara>\r
 302 </listitem>\r
 303 </varlistentry>\r
 304 <varlistentry>\r
 305 <term>\r
 306 --no-reuse-delta\r
 307 </term>\r
 308 <listitem>\r
 309 <simpara>\r
 310         When creating a packed archive in a repository that\r
 311         has existing packs, the command reuses existing deltas.\r
 312         This sometimes results in a slightly suboptimal pack.\r
 313         This flag tells the command not to reuse existing deltas\r
 314         but compute them from scratch.\r
 315 </simpara>\r
 316 </listitem>\r
 317 </varlistentry>\r
 318 <varlistentry>\r
 319 <term>\r
 320 --no-reuse-object\r
 321 </term>\r
 322 <listitem>\r
 323 <simpara>\r
 324         This flag tells the command not to reuse existing object data at all,\r
 325         including non deltified object, forcing recompression of everything.\r
 326         This implies --no-reuse-delta. Useful only in the obscure case where\r
 327         wholesale enforcement of a different compression level on the\r
 328         packed data is desired.\r
 329 </simpara>\r
 330 </listitem>\r
 331 </varlistentry>\r
 332 <varlistentry>\r
 333 <term>\r
 334 --compression=&lt;n&gt;\r
 335 </term>\r
 336 <listitem>\r
 337 <simpara>\r
 338         Specifies compression level for newly-compressed data in the\r
 339         generated pack.  If not specified,  pack compression level is\r
 340         determined first by pack.compression,  then by core.compression,\r
 341         and defaults to -1,  the zlib default,  if neither is set.\r
 342         Add --no-reuse-object if you want to force a uniform compression\r
 343         level on all data no matter the source.\r
 344 </simpara>\r
 345 </listitem>\r
 346 </varlistentry>\r
 347 <varlistentry>\r
 348 <term>\r
 349 --[no-]sparse\r
 350 </term>\r
 351 <listitem>\r
 352 <simpara>\r
 353         Toggle the "sparse" algorithm to determine which objects to include in\r
 354         the pack, when combined with the "--revs" option. This algorithm\r
 355         only walks trees that appear in paths that introduce new objects.\r
 356         This can have significant performance benefits when computing\r
 357         a pack to send a small change. However, it is possible that extra\r
 358         objects are added to the pack-file if the included commits contain\r
 359         certain types of direct renames. If this option is not included,\r
 360         it defaults to the value of <emphasis>pack.useSparse</emphasis>, which is true unless\r
 361         otherwise specified.\r
 362 </simpara>\r
 363 </listitem>\r
 364 </varlistentry>\r
 365 <varlistentry>\r
 366 <term>\r
 367 --thin\r
 368 </term>\r
 369 <listitem>\r
 370 <simpara>\r
 371         Create a "thin" pack by omitting the common objects between a\r
 372         sender and a receiver in order to reduce network transfer. This\r
 373         option only makes sense in conjunction with --stdout.\r
 374 </simpara>\r
 375 <simpara>Note: A thin pack violates the packed archive format by omitting\r
 376 required objects and is thus unusable by Git without making it\r
 377 self-contained. Use <emphasis>git index-pack --fix-thin</emphasis>\r
 378 (see <xref linkend="git-index-pack(1)" />) to restore the self-contained property.</simpara>\r
 379 </listitem>\r
 380 </varlistentry>\r
 381 <varlistentry>\r
 382 <term>\r
 383 --shallow\r
 384 </term>\r
 385 <listitem>\r
 386 <simpara>\r
 387         Optimize a pack that will be provided to a client with a shallow\r
 388         repository.  This option, combined with --thin, can result in a\r
 389         smaller pack at the cost of speed.\r
 390 </simpara>\r
 391 </listitem>\r
 392 </varlistentry>\r
 393 <varlistentry>\r
 394 <term>\r
 395 --delta-base-offset\r
 396 </term>\r
 397 <listitem>\r
 398 <simpara>\r
 399         A packed archive can express the base object of a delta as\r
 400         either a 20-byte object name or as an offset in the\r
 401         stream, but ancient versions of Git don't understand the\r
 402         latter.  By default, <emphasis>git pack-objects</emphasis> only uses the\r
 403         former format for better compatibility.  This option\r
 404         allows the command to use the latter format for\r
 405         compactness.  Depending on the average delta chain\r
 406         length, this option typically shrinks the resulting\r
 407         packfile by 3-5 per-cent.\r
 408 </simpara>\r
 409 <simpara>Note: Porcelain commands such as <emphasis>git gc</emphasis> (see <xref linkend="git-gc(1)" />),\r
 410 <emphasis>git repack</emphasis> (see <xref linkend="git-repack(1)" />) pass this option by default\r
 411 in modern Git when they put objects in your repository into pack files.\r
 412 So does <emphasis>git bundle</emphasis> (see <xref linkend="git-bundle(1)" />) when it creates a bundle.</simpara>\r
 413 </listitem>\r
 414 </varlistentry>\r
 415 <varlistentry>\r
 416 <term>\r
 417 --threads=&lt;n&gt;\r
 418 </term>\r
 419 <listitem>\r
 420 <simpara>\r
 421         Specifies the number of threads to spawn when searching for best\r
 422         delta matches.  This requires that pack-objects be compiled with\r
 423         pthreads otherwise this option is ignored with a warning.\r
 424         This is meant to reduce packing time on multiprocessor machines.\r
 425         The required amount of memory for the delta search window is\r
 426         however multiplied by the number of threads.\r
 427         Specifying 0 will cause Git to auto-detect the number of CPU's\r
 428         and set the number of threads accordingly.\r
 429 </simpara>\r
 430 </listitem>\r
 431 </varlistentry>\r
 432 <varlistentry>\r
 433 <term>\r
 434 --index-version=&lt;version&gt;[,&lt;offset&gt;]\r
 435 </term>\r
 436 <listitem>\r
 437 <simpara>\r
 438         This is intended to be used by the test suite only. It allows\r
 439         to force the version for the generated pack index, and to force\r
 440         64-bit index entries on objects located above the given offset.\r
 441 </simpara>\r
 442 </listitem>\r
 443 </varlistentry>\r
 444 <varlistentry>\r
 445 <term>\r
 446 --keep-true-parents\r
 447 </term>\r
 448 <listitem>\r
 449 <simpara>\r
 450         With this option, parents that are hidden by grafts are packed\r
 451         nevertheless.\r
 452 </simpara>\r
 453 </listitem>\r
 454 </varlistentry>\r
 455 <varlistentry>\r
 456 <term>\r
 457 --filter=&lt;filter-spec&gt;\r
 458 </term>\r
 459 <listitem>\r
 460 <simpara>\r
 461         Requires <emphasis>--stdout</emphasis>.  Omits certain objects (usually blobs) from\r
 462         the resulting packfile.  See <xref linkend="git-rev-list(1)" /> for valid\r
 463         <emphasis>&lt;filter-spec&gt;</emphasis> forms.\r
 464 </simpara>\r
 465 </listitem>\r
 466 </varlistentry>\r
 467 <varlistentry>\r
 468 <term>\r
 469 --no-filter\r
 470 </term>\r
 471 <listitem>\r
 472 <simpara>\r
 473         Turns off any previous <emphasis>--filter=</emphasis> argument.\r
 474 </simpara>\r
 475 </listitem>\r
 476 </varlistentry>\r
 477 <varlistentry>\r
 478 <term>\r
 479 --missing=&lt;missing-action&gt;\r
 480 </term>\r
 481 <listitem>\r
 482 <simpara>\r
 483         A debug option to help with future "partial clone" development.\r
 484         This option specifies how missing objects are handled.\r
 485 </simpara>\r
 486 <simpara>The form <emphasis>--missing=error</emphasis> requests that pack-objects stop with an error if\r
 487 a missing object is encountered.  This is the default action.</simpara>\r
 488 <simpara>The form <emphasis>--missing=allow-any</emphasis> will allow object traversal to continue\r
 489 if a missing object is encountered.  Missing objects will silently be\r
 490 omitted from the results.</simpara>\r
 491 <simpara>The form <emphasis>--missing=allow-promisor</emphasis> is like <emphasis>allow-any</emphasis>, but will only\r
 492 allow object traversal to continue for EXPECTED promisor missing objects.\r
 493 Unexpected missing object will raise an error.</simpara>\r
 494 </listitem>\r
 495 </varlistentry>\r
 496 <varlistentry>\r
 497 <term>\r
 498 --exclude-promisor-objects\r
 499 </term>\r
 500 <listitem>\r
 501 <simpara>\r
 502         Omit objects that are known to be in the promisor remote.  (This\r
 503         option has the purpose of operating only on locally created objects,\r
 504         so that when we repack, we still maintain a distinction between\r
 505         locally created objects [without .promisor] and objects from the\r
 506         promisor remote [with .promisor].)  This is used with partial clone.\r
 507 </simpara>\r
 508 </listitem>\r
 509 </varlistentry>\r
 510 <varlistentry>\r
 511 <term>\r
 512 --keep-unreachable\r
 513 </term>\r
 514 <listitem>\r
 515 <simpara>\r
 516         Objects unreachable from the refs in packs named with\r
 517         --unpacked= option are added to the resulting pack, in\r
 518         addition to the reachable objects that are not in packs marked\r
 519         with *.keep files. This implies <emphasis>--revs</emphasis>.\r
 520 </simpara>\r
 521 </listitem>\r
 522 </varlistentry>\r
 523 <varlistentry>\r
 524 <term>\r
 525 --pack-loose-unreachable\r
 526 </term>\r
 527 <listitem>\r
 528 <simpara>\r
 529         Pack unreachable loose objects (and their loose counterparts\r
 530         removed). This implies <emphasis>--revs</emphasis>.\r
 531 </simpara>\r
 532 </listitem>\r
 533 </varlistentry>\r
 534 <varlistentry>\r
 535 <term>\r
 536 --unpack-unreachable\r
 537 </term>\r
 538 <listitem>\r
 539 <simpara>\r
 540         Keep unreachable objects in loose form. This implies <emphasis>--revs</emphasis>.\r
 541 </simpara>\r
 542 </listitem>\r
 543 </varlistentry>\r
 544 <varlistentry>\r
 545 <term>\r
 546 --delta-islands\r
 547 </term>\r
 548 <listitem>\r
 549 <simpara>\r
 550         Restrict delta matches based on "islands". See DELTA ISLANDS\r
 551         below.\r
 552 </simpara>\r
 553 </listitem>\r
 554 </varlistentry>\r
 555 </variablelist>\r
 556 </simplesect>\r
 557 <simplesect id="git-pack-objects(1)__delta_islands">\r
 558 <title>DELTA ISLANDS</title>\r
 559 <simpara>When possible, <emphasis>pack-objects</emphasis> tries to reuse existing on-disk deltas to\r
 560 avoid having to search for new ones on the fly. This is an important\r
 561 optimization for serving fetches, because it means the server can avoid\r
 562 inflating most objects at all and just send the bytes directly from\r
 563 disk. This optimization can't work when an object is stored as a delta\r
 564 against a base which the receiver does not have (and which we are not\r
 565 already sending). In that case the server "breaks" the delta and has to\r
 566 find a new one, which has a high CPU cost. Therefore it's important for\r
 567 performance that the set of objects in on-disk delta relationships match\r
 568 what a client would fetch.</simpara>\r
 569 <simpara>In a normal repository, this tends to work automatically. The objects\r
 570 are mostly reachable from the branches and tags, and that's what clients\r
 571 fetch. Any deltas we find on the server are likely to be between objects\r
 572 the client has or will have.</simpara>\r
 573 <simpara>But in some repository setups, you may have several related but separate\r
 574 groups of ref tips, with clients tending to fetch those groups\r
 575 independently. For example, imagine that you are hosting several "forks"\r
 576 of a repository in a single shared object store, and letting clients\r
 577 view them as separate repositories through <emphasis>GIT_NAMESPACE</emphasis> or separate\r
 578 repos using the alternates mechanism. A naive repack may find that the\r
 579 optimal delta for an object is against a base that is only found in\r
 580 another fork. But when a client fetches, they will not have the base\r
 581 object, and we'll have to find a new delta on the fly.</simpara>\r
 582 <simpara>A similar situation may exist if you have many refs outside of\r
 583 <emphasis>refs/heads/</emphasis> and <emphasis>refs/tags/</emphasis> that point to related objects (e.g.,\r
 584 <emphasis>refs/pull</emphasis> or <emphasis>refs/changes</emphasis> used by some hosting providers). By\r
 585 default, clients fetch only heads and tags, and deltas against objects\r
 586 found only in those other groups cannot be sent as-is.</simpara>\r
 587 <simpara>Delta islands solve this problem by allowing you to group your refs into\r
 588 distinct "islands". Pack-objects computes which objects are reachable\r
 589 from which islands, and refuses to make a delta from an object <emphasis>A</emphasis>\r
 590 against a base which is not present in all of <emphasis>A</emphasis>'s islands. This\r
 591 results in slightly larger packs (because we miss some delta\r
 592 opportunities), but guarantees that a fetch of one island will not have\r
 593 to recompute deltas on the fly due to crossing island boundaries.</simpara>\r
 594 <simpara>When repacking with delta islands the delta window tends to get\r
 595 clogged with candidates that are forbidden by the config. Repacking\r
 596 with a big --window helps (and doesn't take as long as it otherwise\r
 597 might because we can reject some object pairs based on islands before\r
 598 doing any computation on the content).</simpara>\r
 599 <simpara>Islands are configured via the <emphasis>pack.island</emphasis> option, which can be\r
 600 specified multiple times. Each value is a left-anchored regular\r
 601 expressions matching refnames. For example:</simpara>\r
 602 <screen>[pack]\r
 603 island = refs/heads/\r
 604 island = refs/tags/</screen>\r
 605 <simpara>puts heads and tags into an island (whose name is the empty string; see\r
 606 below for more on naming). Any refs which do not match those regular\r
 607 expressions (e.g., <emphasis>refs/pull/123</emphasis>) is not in any island. Any object\r
 608 which is reachable only from <emphasis>refs/pull/</emphasis> (but not heads or tags) is\r
 609 therefore not a candidate to be used as a base for <emphasis>refs/heads/</emphasis>.</simpara>\r
 610 <simpara>Refs are grouped into islands based on their "names", and two regexes\r
 611 that produce the same name are considered to be in the same\r
 612 island. The names are computed from the regexes by concatenating any\r
 613 capture groups from the regex, with a <emphasis>-</emphasis> dash in between. (And if\r
 614 there are no capture groups, then the name is the empty string, as in\r
 615 the above example.) This allows you to create arbitrary numbers of\r
 616 islands. Only up to 14 such capture groups are supported though.</simpara>\r
 617 <simpara>For example, imagine you store the refs for each fork in\r
 618 <emphasis>refs/virtual/ID</emphasis>, where <emphasis>ID</emphasis> is a numeric identifier. You might then\r
 619 configure:</simpara>\r
 620 <screen>[pack]\r
 621 island = refs/virtual/([0-9]+)/heads/\r
 622 island = refs/virtual/([0-9]+)/tags/\r
 623 island = refs/virtual/([0-9]+)/(pull)/</screen>\r
 624 <simpara>That puts the heads and tags for each fork in their own island (named\r
 625 "1234" or similar), and the pull refs for each go into their own\r
 626 "1234-pull".</simpara>\r
 627 <simpara>Note that we pick a single island for each regex to go into, using "last\r
 628 one wins" ordering (which allows repo-specific config to take precedence\r
 629 over user-wide config, and so forth).</simpara>\r
 630 </simplesect>\r
 631 <simplesect id="git-pack-objects(1)__see_also">\r
 632 <title>SEE ALSO</title>\r
 633 <simpara><xref linkend="git-rev-list(1)" />\r
 634 <xref linkend="git-repack(1)" />\r
 635 <xref linkend="git-prune-packed(1)" /></simpara>\r
 636 </simplesect>\r
 637 <simplesect id="git-pack-objects(1)__git">\r
 638 <title>GIT</title>\r
 639 <simpara>Part of the <xref linkend="git(1)" /> suite</simpara>\r
 640 </simplesect>\r
 641 </sect2>\r