git-pack-objects.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.2" />\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-pack-objects(1)</title>\r
 260 </head>\r
 261 <body>\r
 262 <div id="header">\r
 263 <h1>\r
 264 git-pack-objects(1) Manual Page\r
 265 </h1>\r
 266 <h2>NAME</h2>\r
 267 <div class="sectionbody">\r
 268 <p>git-pack-objects -\r
 269    Create a packed archive of objects\r
 270 </p>\r
 271 </div>\r
 272 </div>\r
 273 <h2>SYNOPSIS</h2>\r
 274 <div class="sectionbody">\r
 275 <div class="verseblock">\r
 276 <div class="content"><em>git-pack-objects</em> [-q] [--no-reuse-delta] [--non-empty]\r
 277         [--local] [--incremental] [--window=N] [--depth=N]\r
 278         {--stdout | base-name} &lt; object-list</div></div>\r
 279 </div>\r
 280 <h2>DESCRIPTION</h2>\r
 281 <div class="sectionbody">\r
 282 <p>Reads list of objects from the standard input, and writes a packed\r
 283 archive with specified base-name, or to the standard output.</p>\r
 284 <p>A packed archive is an efficient way to transfer set of objects\r
 285 between two repositories, and also is an archival format which\r
 286 is efficient to access.  The packed archive format (.pack) is\r
 287 designed to be unpackable without having anything else, but for\r
 288 random access, accompanied with the pack index file (.idx).</p>\r
 289 <p><em>git-unpack-objects</em> command can read the packed archive and\r
 290 expand the objects contained in the pack into "one-file\r
 291 one-object" format; this is typically done by the smart-pull\r
 292 commands when a pack is created on-the-fly for efficient network\r
 293 transport by their peers.</p>\r
 294 <p>Placing both in the pack/ subdirectory of $GIT_OBJECT_DIRECTORY (or\r
 295 any of the directories on $GIT_ALTERNATE_OBJECT_DIRECTORIES)\r
 296 enables git to read from such an archive.</p>\r
 297 <p>In a packed archive, an object is either stored as a compressed\r
 298 whole, or as a difference from some other object.  The latter is\r
 299 often called a delta.</p>\r
 300 </div>\r
 301 <h2>OPTIONS</h2>\r
 302 <div class="sectionbody">\r
 303 <dl>\r
 304 <dt>\r
 305 base-name\r
 306 </dt>\r
 307 <dd>\r
 308 <p>\r
 309         Write into a pair of files (.pack and .idx), using\r
 310         &lt;base-name&gt; to determine the name of the created file.\r
 311         When this option is used, the two files are written in\r
 312         &lt;base-name&gt;-&lt;SHA1&gt;.{pack,idx} files.  &lt;SHA1&gt; is a hash\r
 313         of object names (currently in random order so it does\r
 314         not have any useful meaning) to make the resulting\r
 315         filename reasonably unique, and written to the standard\r
 316         output of the command.\r
 317 </p>\r
 318 </dd>\r
 319 <dt>\r
 320 --stdout\r
 321 </dt>\r
 322 <dd>\r
 323 <p>\r
 324         Write the pack contents (what would have been written to\r
 325         .pack file) out to the standard output.\r
 326 </p>\r
 327 </dd>\r
 328 <dt>\r
 329 --window and --depth\r
 330 </dt>\r
 331 <dd>\r
 332 <p>\r
 333         These two options affects how the objects contained in\r
 334         the pack are stored using delta compression.  The\r
 335         objects are first internally sorted by type, size and\r
 336         optionally names and compared against the other objects\r
 337         within --window to see if using delta compression saves\r
 338         space.  --depth limits the maximum delta depth; making\r
 339         it too deep affects the performance on the unpacker\r
 340         side, because delta data needs to be applied that many\r
 341         times to get to the necessary object.\r
 342 </p>\r
 343 </dd>\r
 344 <dt>\r
 345 --incremental\r
 346 </dt>\r
 347 <dd>\r
 348 <p>\r
 349         This flag causes an object already in a pack ignored\r
 350         even if it appears in the standard input.\r
 351 </p>\r
 352 </dd>\r
 353 <dt>\r
 354 --local\r
 355 </dt>\r
 356 <dd>\r
 357 <p>\r
 358         This flag is similar to <tt>--incremental</tt>; instead of\r
 359         ignoring all packed objects, it only ignores objects\r
 360         that are packed and not in the local object store\r
 361         (i.e. borrowed from an alternate).\r
 362 </p>\r
 363 </dd>\r
 364 <dt>\r
 365 --non-empty\r
 366 </dt>\r
 367 <dd>\r
 368 <p>\r
 369         Only create a packed archive if it would contain at\r
 370         least one object.\r
 371 </p>\r
 372 </dd>\r
 373 <dt>\r
 374 -q\r
 375 </dt>\r
 376 <dd>\r
 377 <p>\r
 378         This flag makes the command not to report its progress\r
 379         on the standard error stream.\r
 380 </p>\r
 381 </dd>\r
 382 <dt>\r
 383 --no-reuse-delta\r
 384 </dt>\r
 385 <dd>\r
 386 <p>\r
 387         When creating a packed archive in a repository that\r
 388         has existing packs, the command reuses existing deltas.\r
 389         This sometimes results in a slightly suboptimal pack.\r
 390         This flag tells the command not to reuse existing deltas\r
 391         but compute them from scratch.\r
 392 </p>\r
 393 </dd>\r
 394 </dl>\r
 395 </div>\r
 396 <h2>Author</h2>\r
 397 <div class="sectionbody">\r
 398 <p>Written by Linus Torvalds &lt;torvalds@osdl.org&gt;</p>\r
 399 </div>\r
 400 <h2>Documentation</h2>\r
 401 <div class="sectionbody">\r
 402 <p>Documentation by Junio C Hamano</p>\r
 403 </div>\r
 404 <h2>See Also</h2>\r
 405 <div class="sectionbody">\r
 406 <p><a href="git-repack.html">git-repack(1)</a>\r
 407 <a href="git-prune-packed.html">git-prune-packed(1)</a></p>\r
 408 </div>\r
 409 <h2>GIT</h2>\r
 410 <div class="sectionbody">\r
 411 <p>Part of the <a href="git.html">git(7)</a> suite</p>\r
 412 </div>\r
 413 <div id="footer">\r
 414 <div id="footer-text">\r
 415 Last updated 10-Mar-2006 00:31:30 UTC\r
 416 </div>\r
 417 </div>\r
 418 </body>\r
 419 </html>\r