Google Git
Sign in
chromium / external / gitster / git-htmldocs / 70e980e01bc36d4da977bf70b79fd3491df4a92d / . / git-pack-objects.html
blob: 3ca37eddb179cef49795460a33df5afe12198e8a [file] [log] [blame]
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
4<head>
5<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]6<meta name="generator" content="AsciiDoc 8.5.2" />
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]7<title>git-pack-objects(1)</title>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]8<style type="text/css">
9/* Debug borders */
10p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
11/*
12 border: 1px solid red;
13*/
14}
15
16body {
17 margin: 1em 5% 1em 5%;
18}
19
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]20a {
21 color: blue;
22 text-decoration: underline;
23}
24a:visited {
25 color: fuchsia;
26}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]27
28em {
29 font-style: italic;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]30 color: navy;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]31}
32
33strong {
34 font-weight: bold;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]35 color: #083194;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]36}
37
38tt {
39 color: navy;
40}
41
42h1, h2, h3, h4, h5, h6 {
43 color: #527bbd;
44 font-family: sans-serif;
45 margin-top: 1.2em;
46 margin-bottom: 0.5em;
47 line-height: 1.3;
48}
49
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]50h1, h2, h3 {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]51 border-bottom: 2px solid silver;
52}
53h2 {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]54 padding-top: 0.5em;
55}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]56h3 {
57 float: left;
58}
59h3 + * {
60 clear: left;
61}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]62
63div.sectionbody {
64 font-family: serif;
65 margin-left: 0;
66}
67
68hr {
69 border: 1px solid silver;
70}
71
72p {
73 margin-top: 0.5em;
74 margin-bottom: 0.5em;
75}
76
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]77ul, ol, li > p {
78 margin-top: 0;
79}
80
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]81pre {
82 padding: 0;
83 margin: 0;
84}
85
86span#author {
87 color: #527bbd;
88 font-family: sans-serif;
89 font-weight: bold;
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]90 font-size: 1.1em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]91}
92span#email {
93}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]94span#revnumber, span#revdate, span#revremark {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]95 font-family: sans-serif;
96}
97
98div#footer {
99 font-family: sans-serif;
100 font-size: small;
101 border-top: 2px solid silver;
102 padding-top: 0.5em;
103 margin-top: 4.0em;
104}
105div#footer-text {
106 float: left;
107 padding-bottom: 0.5em;
108}
109div#footer-badges {
110 float: right;
111 padding-bottom: 0.5em;
112}
113
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]114div#preamble {
115 margin-top: 1.5em;
116 margin-bottom: 1.5em;
117}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]118div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
119div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
120div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]121 margin-top: 1.0em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]122 margin-bottom: 1.5em;
123}
124div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]125 margin-top: 2.0em;
126 margin-bottom: 2.0em;
127 margin-right: 10%;
128 color: #606060;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]129}
130
131div.content { /* Block element content. */
132 padding: 0;
133}
134
135/* Block element titles. */
136div.title, caption.title {
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]137 color: #527bbd;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]138 font-family: sans-serif;
139 font-weight: bold;
140 text-align: left;
141 margin-top: 1.0em;
142 margin-bottom: 0.5em;
143}
144div.title + * {
145 margin-top: 0;
146}
147
148td div.title:first-child {
149 margin-top: 0.0em;
150}
151div.content div.title:first-child {
152 margin-top: 0.0em;
153}
154div.content + div.title {
155 margin-top: 0.0em;
156}
157
158div.sidebarblock > div.content {
159 background: #ffffee;
160 border: 1px solid silver;
161 padding: 0.5em;
162}
163
164div.listingblock > div.content {
165 border: 1px solid silver;
166 background: #f4f4f4;
167 padding: 0.5em;
168}
169
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]170div.quoteblock, div.verseblock {
171 padding-left: 1.0em;
172 margin-left: 1.0em;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]173 margin-right: 10%;
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]174 border-left: 5px solid #dddddd;
175 color: #777777;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]176}
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]177
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]178div.quoteblock > div.attribution {
179 padding-top: 0.5em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]180 text-align: right;
181}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]182
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]183div.verseblock > div.content {
184 white-space: pre;
185}
186div.verseblock > div.attribution {
187 padding-top: 0.75em;
188 text-align: left;
189}
190/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]191div.verseblock + div.attribution {
192 text-align: left;
193}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]194
195div.admonitionblock .icon {
196 vertical-align: top;
197 font-size: 1.1em;
198 font-weight: bold;
199 text-decoration: underline;
200 color: #527bbd;
201 padding-right: 0.5em;
202}
203div.admonitionblock td.content {
204 padding-left: 0.5em;
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]205 border-left: 3px solid #dddddd;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]206}
207
208div.exampleblock > div.content {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]209 border-left: 3px solid #dddddd;
210 padding-left: 0.5em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]211}
212
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]213div.imageblock div.content { padding-left: 0; }
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]214span.image img { border-style: none; }
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]215a.image:visited { color: white; }
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]216
217dl {
218 margin-top: 0.8em;
219 margin-bottom: 0.8em;
220}
221dt {
222 margin-top: 0.5em;
223 margin-bottom: 0;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]224 font-style: normal;
225 color: navy;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]226}
227dd > *:first-child {
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]228 margin-top: 0.1em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]229}
230
231ul, ol {
232 list-style-position: outside;
233}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]234ol.arabic {
235 list-style-type: decimal;
236}
237ol.loweralpha {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]238 list-style-type: lower-alpha;
239}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]240ol.upperalpha {
241 list-style-type: upper-alpha;
242}
243ol.lowerroman {
244 list-style-type: lower-roman;
245}
246ol.upperroman {
247 list-style-type: upper-roman;
248}
249
250div.compact ul, div.compact ol,
251div.compact p, div.compact p,
252div.compact div, div.compact div {
253 margin-top: 0.1em;
254 margin-bottom: 0.1em;
255}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]256
257div.tableblock > table {
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]258 border: 3px solid #527bbd;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]259}
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]260thead, p.table.header {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]261 font-family: sans-serif;
262 font-weight: bold;
263}
264tfoot {
265 font-weight: bold;
266}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]267td > div.verse {
268 white-space: pre;
269}
270p.table {
271 margin-top: 0;
272}
273/* Because the table frame attribute is overriden by CSS in most browsers. */
274div.tableblock > table[frame="void"] {
275 border-style: none;
276}
277div.tableblock > table[frame="hsides"] {
278 border-left-style: none;
279 border-right-style: none;
280}
281div.tableblock > table[frame="vsides"] {
282 border-top-style: none;
283 border-bottom-style: none;
284}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]285
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]286
287div.hdlist {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]288 margin-top: 0.8em;
289 margin-bottom: 0.8em;
290}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]291div.hdlist tr {
292 padding-bottom: 15px;
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]293}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]294dt.hdlist1.strong, td.hdlist1.strong {
295 font-weight: bold;
296}
297td.hdlist1 {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]298 vertical-align: top;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]299 font-style: normal;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]300 padding-right: 0.8em;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]301 color: navy;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]302}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]303td.hdlist2 {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]304 vertical-align: top;
305}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]306div.hdlist.compact tr {
307 margin: 0;
308 padding-bottom: 0;
309}
310
311.comment {
312 background: yellow;
313}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]314
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]315.footnote, .footnoteref {
316 font-size: 0.8em;
317}
318
319span.footnote, span.footnoteref {
320 vertical-align: super;
321}
322
323#footnotes {
324 margin: 20px 0 20px 0;
325 padding: 7px 0 0 0;
326}
327
328#footnotes div.footnote {
329 margin: 0 0 5px 0;
330}
331
332#footnotes hr {
333 border: none;
334 border-top: 1px solid silver;
335 height: 1px;
336 text-align: left;
337 margin-left: 0;
338 width: 20%;
339 min-width: 100px;
340}
341
342
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]343@media print {
344 div#footer-badges { display: none; }
345}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]346
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]347div#toc {
348 margin-bottom: 2.5em;
349}
350
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]351div#toctitle {
352 color: #527bbd;
353 font-family: sans-serif;
354 font-size: 1.1em;
355 font-weight: bold;
356 margin-top: 1.0em;
357 margin-bottom: 0.1em;
358}
359
360div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
361 margin-top: 0;
362 margin-bottom: 0;
363}
364div.toclevel2 {
365 margin-left: 2em;
366 font-size: 0.9em;
367}
368div.toclevel3 {
369 margin-left: 4em;
370 font-size: 0.9em;
371}
372div.toclevel4 {
373 margin-left: 6em;
374 font-size: 0.9em;
375}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]376/* Overrides for manpage documents */
377h1 {
378 padding-top: 0.5em;
379 padding-bottom: 0.5em;
380 border-top: 2px solid silver;
381 border-bottom: 2px solid silver;
382}
383h2 {
384 border-style: none;
385}
386div.sectionbody {
387 margin-left: 5%;
388}
389
390@media print {
391 div#toc { display: none; }
392}
393
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]394/* Workarounds for IE6's broken and incomplete CSS2. */
395
396div.sidebar-content {
397 background: #ffffee;
398 border: 1px solid silver;
399 padding: 0.5em;
400}
401div.sidebar-title, div.image-title {
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]402 color: #527bbd;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]403 font-family: sans-serif;
404 font-weight: bold;
405 margin-top: 0.0em;
406 margin-bottom: 0.5em;
407}
408
409div.listingblock div.content {
410 border: 1px solid silver;
411 background: #f4f4f4;
412 padding: 0.5em;
413}
414
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]415div.quoteblock-attribution {
416 padding-top: 0.5em;
417 text-align: right;
418}
419
420div.verseblock-content {
421 white-space: pre;
422}
423div.verseblock-attribution {
424 padding-top: 0.75em;
425 text-align: left;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]426}
427
428div.exampleblock-content {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]429 border-left: 3px solid #dddddd;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]430 padding-left: 0.5em;
431}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]432
433/* IE6 sets dynamically generated links as visited. */
434div#toc a:visited { color: blue; }
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]435</style>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]436<script type="text/javascript">
437/*<![CDATA[*/
438window.onload = function(){asciidoc.footnotes();}
439var asciidoc = { // Namespace.
440
441/////////////////////////////////////////////////////////////////////
442// Table Of Contents generator
443/////////////////////////////////////////////////////////////////////
444
445/* Author: Mihai Bazon, September 2002
446 * http://students.infoiasi.ro/~mishoo
447 *
448 * Table Of Content generator
449 * Version: 0.4
450 *
451 * Feel free to use this script under the terms of the GNU General Public
452 * License, as long as you do not remove or alter this notice.
453 */
454
455 /* modified by Troy D. Hanson, September 2006. License: GPL */
456 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
457
458// toclevels = 1..4.
459toc: function (toclevels) {
460
461 function getText(el) {
462 var text = "";
463 for (var i = el.firstChild; i != null; i = i.nextSibling) {
464 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
465 text += i.data;
466 else if (i.firstChild != null)
467 text += getText(i);
468 }
469 return text;
470 }
471
472 function TocEntry(el, text, toclevel) {
473 this.element = el;
474 this.text = text;
475 this.toclevel = toclevel;
476 }
477
478 function tocEntries(el, toclevels) {
479 var result = new Array;
480 var re = new RegExp('[hH]([2-'+(toclevels+1)+'])');
481 // Function that scans the DOM tree for header elements (the DOM2
482 // nodeIterator API would be a better technique but not supported by all
483 // browsers).
484 var iterate = function (el) {
485 for (var i = el.firstChild; i != null; i = i.nextSibling) {
486 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
487 var mo = re.exec(i.tagName);
488 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
489 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
490 }
491 iterate(i);
492 }
493 }
494 }
495 iterate(el);
496 return result;
497 }
498
499 var toc = document.getElementById("toc");
500 var entries = tocEntries(document.getElementById("content"), toclevels);
501 for (var i = 0; i < entries.length; ++i) {
502 var entry = entries[i];
503 if (entry.element.id == "")
504 entry.element.id = "_toc_" + i;
505 var a = document.createElement("a");
506 a.href = "#" + entry.element.id;
507 a.appendChild(document.createTextNode(entry.text));
508 var div = document.createElement("div");
509 div.appendChild(a);
510 div.className = "toclevel" + entry.toclevel;
511 toc.appendChild(div);
512 }
513 if (entries.length == 0)
514 toc.parentNode.removeChild(toc);
515},
516
517
518/////////////////////////////////////////////////////////////////////
519// Footnotes generator
520/////////////////////////////////////////////////////////////////////
521
522/* Based on footnote generation code from:
523 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
524 */
525
526footnotes: function () {
527 var cont = document.getElementById("content");
528 var noteholder = document.getElementById("footnotes");
529 var spans = cont.getElementsByTagName("span");
530 var refs = {};
531 var n = 0;
532 for (i=0; i<spans.length; i++) {
533 if (spans[i].className == "footnote") {
534 n++;
535 // Use [\s\S] in place of . so multi-line matches work.
536 // Because JavaScript has no s (dotall) regex flag.
537 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
538 noteholder.innerHTML +=
539 "<div class='footnote' id='_footnote_" + n + "'>" +
540 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
541 n + "</a>. " + note + "</div>";
542 spans[i].innerHTML =
543 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
544 "' title='View footnote' class='footnote'>" + n + "</a>]";
545 var id =spans[i].getAttribute("id");
546 if (id != null) refs["#"+id] = n;
547 }
548 }
549 if (n == 0)
550 noteholder.parentNode.removeChild(noteholder);
551 else {
552 // Process footnoterefs.
553 for (i=0; i<spans.length; i++) {
554 if (spans[i].className == "footnoteref") {
555 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
556 href = href.match(/#.*/)[0]; // Because IE return full URL.
557 n = refs[href];
558 spans[i].innerHTML =
559 "[<a href='#_footnote_" + n +
560 "' title='View footnote' class='footnote'>" + n + "</a>]";
561 }
562 }
563 }
564}
565
566}
567/*]]>*/
568</script>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]569</head>
570<body>
571<div id="header">
572<h1>
573git-pack-objects(1) Manual Page
574</h1>
575<h2>NAME</h2>
576<div class="sectionbody">
577<p>git-pack-objects -
Junio C Hamano01078922006-03-10 00:31:47[diff] [blame]578 Create a packed archive of objects
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]579</p>
580</div>
581</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]582<div id="content">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]583<h2 id="_synopsis">SYNOPSIS</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]584<div class="sectionbody">
Junio C Hamano7e9f6b72006-02-22 10:44:55[diff] [blame]585<div class="verseblock">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]586<div class="verseblock-content"><em>git pack-objects</em> [-q | --progress | --all-progress] [--all-progress-implied]
Junio C Hamano5706e0b2009-11-24 10:54:16[diff] [blame]587 [--no-reuse-delta] [--delta-base-offset] [--non-empty]
Junio C Hamanod2179ef2010-10-22 04:12:17[diff] [blame]588 [--local] [--incremental] [--window=&lt;n&gt;] [--depth=&lt;n&gt;]
589 [--revs [--unpacked | --all]] [--stdout | base-name]
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]590 [--keep-true-parents] &lt; object-list</div>
591<div class="verseblock-attribution">
592</div></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]593</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]594<h2 id="_description">DESCRIPTION</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]595<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]596<div class="paragraph"><p>Reads list of objects from the standard input, and writes a packed
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]597archive with specified base-name, or to the standard output.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]598<div class="paragraph"><p>A packed archive is an efficient way to transfer a set of objects
Junio C Hamano4fdccb22010-02-19 09:58:14[diff] [blame]599between two repositories as well as an access efficient archival
600format. In a packed archive, an object is either stored as a
601compressed whole or as a difference from some other object.
602The latter is often called a delta.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]603<div class="paragraph"><p>The packed archive format (.pack) is designed to be self-contained
Junio C Hamano4fdccb22010-02-19 09:58:14[diff] [blame]604so that it can be unpacked without any further information. Therefore,
605each object that a delta depends upon must be present within the pack.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]606<div class="paragraph"><p>A pack index file (.idx) is generated for fast, random access to the
Junio C Hamano4fdccb22010-02-19 09:58:14[diff] [blame]607objects in the pack. Placing both the index file (.idx) and the packed
608archive (.pack) in the pack/ subdirectory of $GIT_OBJECT_DIRECTORY (or
Junio C Hamano9810d632007-09-24 01:05:34[diff] [blame]609any of the directories on $GIT_ALTERNATE_OBJECT_DIRECTORIES)
Junio C Hamano4fdccb22010-02-19 09:58:14[diff] [blame]610enables git to read from the pack archive.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]611<div class="paragraph"><p>The <em>git unpack-objects</em> command can read the packed archive and
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]612expand the objects contained in the pack into "one-file
613one-object" format; this is typically done by the smart-pull
614commands when a pack is created on-the-fly for efficient network
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]615transport by their peers.</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]616</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]617<h2 id="_options">OPTIONS</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]618<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]619<div class="dlist"><dl>
620<dt class="hdlist1">
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]621base-name
622</dt>
623<dd>
624<p>
625 Write into a pair of files (.pack and .idx), using
626 &lt;base-name&gt; to determine the name of the created file.
627 When this option is used, the two files are written in
628 &lt;base-name&gt;-&lt;SHA1&gt;.{pack,idx} files. &lt;SHA1&gt; is a hash
Junio C Hamanoa2ec14f2006-11-02 00:22:48[diff] [blame]629 of the sorted object names to make the resulting filename
630 based on the pack content, and written to the standard
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]631 output of the command.
632</p>
633</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]634<dt class="hdlist1">
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]635--stdout
636</dt>
637<dd>
638<p>
Junio C Hamano235a91e2006-01-07 01:13:58[diff] [blame]639 Write the pack contents (what would have been written to
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]640 .pack file) out to the standard output.
641</p>
642</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]643<dt class="hdlist1">
Junio C Hamano3eb513f2006-09-18 02:47:16[diff] [blame]644--revs
645</dt>
646<dd>
647<p>
648 Read the revision arguments from the standard input, instead of
649 individual object names. The revision arguments are processed
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]650 the same way as <em>git rev-list</em> with the <tt>--objects</tt> flag
Junio C Hamano3eb513f2006-09-18 02:47:16[diff] [blame]651 uses its <tt>commit</tt> arguments to build the list of objects it
652 outputs. The objects on the resulting list are packed.
653</p>
654</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]655<dt class="hdlist1">
Junio C Hamano3eb513f2006-09-18 02:47:16[diff] [blame]656--unpacked
657</dt>
658<dd>
659<p>
660 This implies <tt>--revs</tt>. When processing the list of
661 revision arguments read from the standard input, limit
662 the objects packed to those that are not already packed.
663</p>
664</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]665<dt class="hdlist1">
Junio C Hamano3eb513f2006-09-18 02:47:16[diff] [blame]666--all
667</dt>
668<dd>
669<p>
670 This implies <tt>--revs</tt>. In addition to the list of
671 revision arguments read from the standard input, pretend
Junio C Hamano4fdccb22010-02-19 09:58:14[diff] [blame]672 as if all refs under <tt>refs/</tt> are specified to be
Junio C Hamano3eb513f2006-09-18 02:47:16[diff] [blame]673 included.
674</p>
675</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]676<dt class="hdlist1">
Junio C Hamanobb343172008-03-09 10:39:09[diff] [blame]677--include-tag
678</dt>
679<dd>
680<p>
681 Include unasked-for annotated tags if the object they
682 reference was included in the resulting packfile. This
683 can be useful to send new tags to native git clients.
684</p>
685</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]686<dt class="hdlist1">
Junio C Hamanod2179ef2010-10-22 04:12:17[diff] [blame]687--window=&lt;n&gt;
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]688</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]689<dt class="hdlist1">
Junio C Hamanod2179ef2010-10-22 04:12:17[diff] [blame]690--depth=&lt;n&gt;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]691</dt>
692<dd>
693<p>
Junio C Hamano93567a62006-10-08 08:47:56[diff] [blame]694 These two options affect how the objects contained in
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]695 the pack are stored using delta compression. The
696 objects are first internally sorted by type, size and
697 optionally names and compared against the other objects
698 within --window to see if using delta compression saves
699 space. --depth limits the maximum delta depth; making
700 it too deep affects the performance on the unpacker
701 side, because delta data needs to be applied that many
702 times to get to the necessary object.
Junio C Hamano91d44c52007-05-09 07:16:07[diff] [blame]703 The default value for --window is 10 and --depth is 50.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]704</p>
705</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]706<dt class="hdlist1">
Junio C Hamanod2179ef2010-10-22 04:12:17[diff] [blame]707--window-memory=&lt;n&gt;
Junio C Hamano235d53f2007-07-13 00:25:15[diff] [blame]708</dt>
709<dd>
710<p>
711 This option provides an additional limit on top of <tt>--window</tt>;
712 the window size will dynamically scale down so as to not take
Junio C Hamanod2179ef2010-10-22 04:12:17[diff] [blame]713 up more than <em>&lt;n&gt;</em> bytes in memory. This is useful in
Junio C Hamano235d53f2007-07-13 00:25:15[diff] [blame]714 repositories with a mix of large and small objects to not run
715 out of memory with a large window, but still be able to take
716 advantage of the large window for the smaller objects. The
717 size can be suffixed with "k", "m", or "g".
718 <tt>--window-memory=0</tt> makes memory usage unlimited, which is the
719 default.
720</p>
721</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]722<dt class="hdlist1">
Junio C Hamanod2179ef2010-10-22 04:12:17[diff] [blame]723--max-pack-size=&lt;n&gt;
Junio C Hamano591dc6a2007-05-29 09:18:19[diff] [blame]724</dt>
725<dd>
726<p>
Junio C Hamano4d979582010-02-04 06:27:29[diff] [blame]727 Maximum size of each output pack file. The size can be suffixed with
728 "k", "m", or "g". The minimum size allowed is limited to 1 MiB.
Junio C Hamano591dc6a2007-05-29 09:18:19[diff] [blame]729 If specified, multiple packfiles may be created.
Junio C Hamano49dccaf2008-02-10 10:48:01[diff] [blame]730 The default is unlimited, unless the config variable
731 <tt>pack.packSizeLimit</tt> is set.
Junio C Hamano591dc6a2007-05-29 09:18:19[diff] [blame]732</p>
733</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]734<dt class="hdlist1">
Junio C Hamano28363492008-11-14 08:26:31[diff] [blame]735--honor-pack-keep
736</dt>
737<dd>
738<p>
739 This flag causes an object already in a local pack that
Junio C Hamano3eee5872011-04-13 22:40:23[diff] [blame]740 has a .keep file to be ignored, even if it would have
Junio C Hamano636c8b22010-03-07 22:25:17[diff] [blame]741 otherwise been packed.
Junio C Hamano28363492008-11-14 08:26:31[diff] [blame]742</p>
743</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]744<dt class="hdlist1">
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]745--incremental
746</dt>
747<dd>
748<p>
Junio C Hamano636c8b22010-03-07 22:25:17[diff] [blame]749 This flag causes an object already in a pack to be ignored
750 even if it would have otherwise been packed.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]751</p>
752</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]753<dt class="hdlist1">
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]754--local
755</dt>
756<dd>
757<p>
Junio C Hamano636c8b22010-03-07 22:25:17[diff] [blame]758 This flag causes an object that is borrowed from an alternate
759 object store to be ignored even if it would have otherwise been
760 packed.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]761</p>
762</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]763<dt class="hdlist1">
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]764--non-empty
765</dt>
766<dd>
767<p>
768 Only create a packed archive if it would contain at
769 least one object.
770</p>
771</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]772<dt class="hdlist1">
Junio C Hamano0d3c8152006-11-08 01:33:41[diff] [blame]773--progress
774</dt>
775<dd>
776<p>
777 Progress status is reported on the standard error stream
778 by default when it is attached to a terminal, unless -q
779 is specified. This flag forces progress status even if
780 the standard error stream is not directed to a terminal.
781</p>
782</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]783<dt class="hdlist1">
Junio C Hamano0d3c8152006-11-08 01:33:41[diff] [blame]784--all-progress
785</dt>
786<dd>
787<p>
788 When --stdout is specified then progress report is
Junio C Hamano5706e0b2009-11-24 10:54:16[diff] [blame]789 displayed during the object count and compression phases
Junio C Hamano0d3c8152006-11-08 01:33:41[diff] [blame]790 but inhibited during the write-out phase. The reason is
791 that in some cases the output stream is directly linked
792 to another command which may wish to display progress
793 status of its own as it processes incoming pack data.
794 This flag is like --progress except that it forces progress
795 report for the write-out phase as well even if --stdout is
796 used.
797</p>
798</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]799<dt class="hdlist1">
Junio C Hamano5706e0b2009-11-24 10:54:16[diff] [blame]800--all-progress-implied
801</dt>
802<dd>
803<p>
804 This is used to imply --all-progress whenever progress display
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]805 is activated. Unlike --all-progress this flag doesn&#8217;t actually
Junio C Hamano5706e0b2009-11-24 10:54:16[diff] [blame]806 force any progress display by itself.
807</p>
808</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]809<dt class="hdlist1">
Junio C Hamano7e9f6b72006-02-22 10:44:55[diff] [blame]810-q
811</dt>
812<dd>
813<p>
814 This flag makes the command not to report its progress
815 on the standard error stream.
816</p>
817</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]818<dt class="hdlist1">
Junio C Hamano7e9f6b72006-02-22 10:44:55[diff] [blame]819--no-reuse-delta
820</dt>
821<dd>
822<p>
823 When creating a packed archive in a repository that
824 has existing packs, the command reuses existing deltas.
825 This sometimes results in a slightly suboptimal pack.
826 This flag tells the command not to reuse existing deltas
827 but compute them from scratch.
828</p>
829</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]830<dt class="hdlist1">
Junio C Hamanof2ce2972007-05-20 19:12:09[diff] [blame]831--no-reuse-object
832</dt>
833<dd>
834<p>
835 This flag tells the command not to reuse existing object data at all,
836 including non deltified object, forcing recompression of everything.
837 This implies --no-reuse-delta. Useful only in the obscure case where
838 wholesale enforcement of a different compression level on the
839 packed data is desired.
840</p>
841</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]842<dt class="hdlist1">
Junio C Hamanod2179ef2010-10-22 04:12:17[diff] [blame]843--compression=&lt;n&gt;
Junio C Hamanof2ce2972007-05-20 19:12:09[diff] [blame]844</dt>
845<dd>
846<p>
847 Specifies compression level for newly-compressed data in the
848 generated pack. If not specified, pack compression level is
849 determined first by pack.compression, then by core.compression,
850 and defaults to -1, the zlib default, if neither is set.
Junio C Hamanoef4c2d12007-09-10 08:11:27[diff] [blame]851 Add --no-reuse-object if you want to force a uniform compression
852 level on all data no matter the source.
Junio C Hamanof2ce2972007-05-20 19:12:09[diff] [blame]853</p>
854</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]855<dt class="hdlist1">
Junio C Hamano4fdccb22010-02-19 09:58:14[diff] [blame]856--thin
857</dt>
858<dd>
859<p>
860 Create a "thin" pack by omitting the common objects between a
861 sender and a receiver in order to reduce network transfer. This
862 option only makes sense in conjunction with --stdout.
863</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]864<div class="paragraph"><p>Note: A thin pack violates the packed archive format by omitting
Junio C Hamano4fdccb22010-02-19 09:58:14[diff] [blame]865required objects and is thus unusable by git without making it
866self-contained. Use <tt>git index-pack --fix-thin</tt>
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]867(see <a href="git-index-pack.html">git-index-pack(1)</a>) to restore the self-contained property.</p></div>
Junio C Hamano4fdccb22010-02-19 09:58:14[diff] [blame]868</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]869<dt class="hdlist1">
Junio C Hamano77b7e902006-10-23 07:18:50[diff] [blame]870--delta-base-offset
871</dt>
872<dd>
873<p>
Junio C Hamano059bca52011-03-30 22:47:46[diff] [blame]874 A packed archive can express the base object of a delta as
875 either a 20-byte object name or as an offset in the
Junio C Hamanoa7e3c512011-04-03 08:34:11[diff] [blame]876 stream, but ancient versions of git don&#8217;t understand the
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]877 latter. By default, <em>git pack-objects</em> only uses the
Junio C Hamano77b7e902006-10-23 07:18:50[diff] [blame]878 former format for better compatibility. This option
879 allows the command to use the latter format for
880 compactness. Depending on the average delta chain
881 length, this option typically shrinks the resulting
882 packfile by 3-5 per-cent.
883</p>
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]884<div class="paragraph"><p>Note: Porcelain commands such as <tt>git gc</tt> (see <a href="git-gc.html">git-gc(1)</a>),
885<tt>git repack</tt> (see <a href="git-repack.html">git-repack(1)</a>) pass this option by default
Junio C Hamanoa7e3c512011-04-03 08:34:11[diff] [blame]886in modern git when they put objects in your repository into pack files.
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]887So does <tt>git bundle</tt> (see <a href="git-bundle.html">git-bundle(1)</a>) when it creates a bundle.</p></div>
Junio C Hamano77b7e902006-10-23 07:18:50[diff] [blame]888</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]889<dt class="hdlist1">
Junio C Hamano58155b42007-09-15 07:46:14[diff] [blame]890--threads=&lt;n&gt;
891</dt>
892<dd>
893<p>
894 Specifies the number of threads to spawn when searching for best
895 delta matches. This requires that pack-objects be compiled with
896 pthreads otherwise this option is ignored with a warning.
897 This is meant to reduce packing time on multiprocessor machines.
898 The required amount of memory for the delta search window is
899 however multiplied by the number of threads.
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]900 Specifying 0 will cause git to auto-detect the number of CPU&#8217;s
Junio C Hamano24bc09a2008-02-28 00:27:44[diff] [blame]901 and set the number of threads accordingly.
Junio C Hamano58155b42007-09-15 07:46:14[diff] [blame]902</p>
903</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]904<dt class="hdlist1">
Junio C Hamanoe90436a2007-04-22 07:22:13[diff] [blame]905--index-version=&lt;version&gt;[,&lt;offset&gt;]
906</dt>
907<dd>
908<p>
909 This is intended to be used by the test suite only. It allows
910 to force the version for the generated pack index, and to force
911 64-bit index entries on objects located above the given offset.
912</p>
913</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]914<dt class="hdlist1">
Junio C Hamanod594fb62009-07-25 09:09:54[diff] [blame]915--keep-true-parents
916</dt>
917<dd>
918<p>
919 With this option, parents that are hidden by grafts are packed
920 nevertheless.
921</p>
922</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]923</dl></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]924</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]925<h2 id="_see_also">SEE ALSO</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]926<div class="sectionbody">
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]927<div class="paragraph"><p><a href="git-rev-list.html">git-rev-list(1)</a>
928<a href="git-repack.html">git-repack(1)</a>
929<a href="git-prune-packed.html">git-prune-packed(1)</a></p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]930</div>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]931<h2 id="_git">GIT</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]932<div class="sectionbody">
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]933<div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]934</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]935</div>
936<div id="footnotes"><hr /></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]937<div id="footer">
938<div id="footer-text">
Junio C Hamano02194af2011-11-17 20:33:59[diff] [blame]939Last updated 2011-11-15 13:45:02 PDT
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]940</div>
941</div>
942</body>
943</html>