Google Git
Sign in
chromium / external / gitster / git-htmldocs / acfb98de3d9e0df8963c76d7503dd30738beb75b / . / git-pack-objects.html
blob: 41a4fd7dd458cf8e7fc415bd3a9380790d30fd90 [file] [log] [blame]
Junio C Hamanob9d9d902018-05-23 07:07:42[diff] [blame]1<?xml version="1.0" encoding="UTF-8"?>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
3 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
4<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
5<head>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]6<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
Junio C Hamanoa85030a2022-07-27 16:48:21[diff] [blame]7<meta name="generator" content="AsciiDoc 10.2.0" />
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]8<title>git-pack-objects(1)</title>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]9<style type="text/css">
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]10/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
11
12/* Default font. */
13body {
14 font-family: Georgia,serif;
15}
16
17/* Title font. */
18h1, h2, h3, h4, h5, h6,
19div.title, caption.title,
20thead, p.table.header,
21#toctitle,
22#author, #revnumber, #revdate, #revremark,
23#footer {
24 font-family: Arial,Helvetica,sans-serif;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]25}
26
27body {
28 margin: 1em 5% 1em 5%;
29}
30
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]31a {
32 color: blue;
33 text-decoration: underline;
34}
35a:visited {
36 color: fuchsia;
37}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]38
39em {
40 font-style: italic;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]41 color: navy;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]42}
43
44strong {
45 font-weight: bold;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]46 color: #083194;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]47}
48
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]49h1, h2, h3, h4, h5, h6 {
50 color: #527bbd;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]51 margin-top: 1.2em;
52 margin-bottom: 0.5em;
53 line-height: 1.3;
54}
55
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]56h1, h2, h3 {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]57 border-bottom: 2px solid silver;
58}
59h2 {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]60 padding-top: 0.5em;
61}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]62h3 {
63 float: left;
64}
65h3 + * {
66 clear: left;
67}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]68h5 {
69 font-size: 1.0em;
70}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]71
72div.sectionbody {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]73 margin-left: 0;
74}
75
76hr {
77 border: 1px solid silver;
78}
79
80p {
81 margin-top: 0.5em;
82 margin-bottom: 0.5em;
83}
84
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]85ul, ol, li > p {
86 margin-top: 0;
87}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]88ul > li { color: #aaa; }
89ul > li > * { color: black; }
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]90
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]91.monospaced, code, pre {
92 font-family: "Courier New", Courier, monospace;
93 font-size: inherit;
94 color: navy;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]95 padding: 0;
96 margin: 0;
97}
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]98pre {
99 white-space: pre-wrap;
100}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]101
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]102#author {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]103 color: #527bbd;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]104 font-weight: bold;
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]105 font-size: 1.1em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]106}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]107#email {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]108}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]109#revnumber, #revdate, #revremark {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]110}
111
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]112#footer {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]113 font-size: small;
114 border-top: 2px solid silver;
115 padding-top: 0.5em;
116 margin-top: 4.0em;
117}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]118#footer-text {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]119 float: left;
120 padding-bottom: 0.5em;
121}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]122#footer-badges {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]123 float: right;
124 padding-bottom: 0.5em;
125}
126
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]127#preamble {
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]128 margin-top: 1.5em;
129 margin-bottom: 1.5em;
130}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]131div.imageblock, div.exampleblock, div.verseblock,
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]132div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
133div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]134 margin-top: 1.0em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]135 margin-bottom: 1.5em;
136}
137div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]138 margin-top: 2.0em;
139 margin-bottom: 2.0em;
140 margin-right: 10%;
141 color: #606060;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]142}
143
144div.content { /* Block element content. */
145 padding: 0;
146}
147
148/* Block element titles. */
149div.title, caption.title {
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]150 color: #527bbd;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]151 font-weight: bold;
152 text-align: left;
153 margin-top: 1.0em;
154 margin-bottom: 0.5em;
155}
156div.title + * {
157 margin-top: 0;
158}
159
160td div.title:first-child {
161 margin-top: 0.0em;
162}
163div.content div.title:first-child {
164 margin-top: 0.0em;
165}
166div.content + div.title {
167 margin-top: 0.0em;
168}
169
170div.sidebarblock > div.content {
171 background: #ffffee;
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]172 border: 1px solid #dddddd;
173 border-left: 4px solid #f0f0f0;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]174 padding: 0.5em;
175}
176
177div.listingblock > div.content {
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]178 border: 1px solid #dddddd;
179 border-left: 5px solid #f0f0f0;
180 background: #f8f8f8;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]181 padding: 0.5em;
182}
183
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]184div.quoteblock, div.verseblock {
185 padding-left: 1.0em;
186 margin-left: 1.0em;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]187 margin-right: 10%;
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]188 border-left: 5px solid #f0f0f0;
189 color: #888;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]190}
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]191
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]192div.quoteblock > div.attribution {
193 padding-top: 0.5em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]194 text-align: right;
195}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]196
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]197div.verseblock > pre.content {
198 font-family: inherit;
199 font-size: inherit;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]200}
201div.verseblock > div.attribution {
202 padding-top: 0.75em;
203 text-align: left;
204}
205/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]206div.verseblock + div.attribution {
207 text-align: left;
208}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]209
210div.admonitionblock .icon {
211 vertical-align: top;
212 font-size: 1.1em;
213 font-weight: bold;
214 text-decoration: underline;
215 color: #527bbd;
216 padding-right: 0.5em;
217}
218div.admonitionblock td.content {
219 padding-left: 0.5em;
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]220 border-left: 3px solid #dddddd;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]221}
222
223div.exampleblock > div.content {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]224 border-left: 3px solid #dddddd;
225 padding-left: 0.5em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]226}
227
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]228div.imageblock div.content { padding-left: 0; }
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]229span.image img { border-style: none; vertical-align: text-bottom; }
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]230a.image:visited { color: white; }
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]231
232dl {
233 margin-top: 0.8em;
234 margin-bottom: 0.8em;
235}
236dt {
237 margin-top: 0.5em;
238 margin-bottom: 0;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]239 font-style: normal;
240 color: navy;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]241}
242dd > *:first-child {
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]243 margin-top: 0.1em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]244}
245
246ul, ol {
247 list-style-position: outside;
248}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]249ol.arabic {
250 list-style-type: decimal;
251}
252ol.loweralpha {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]253 list-style-type: lower-alpha;
254}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]255ol.upperalpha {
256 list-style-type: upper-alpha;
257}
258ol.lowerroman {
259 list-style-type: lower-roman;
260}
261ol.upperroman {
262 list-style-type: upper-roman;
263}
264
265div.compact ul, div.compact ol,
266div.compact p, div.compact p,
267div.compact div, div.compact div {
268 margin-top: 0.1em;
269 margin-bottom: 0.1em;
270}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]271
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]272tfoot {
273 font-weight: bold;
274}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]275td > div.verse {
276 white-space: pre;
277}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]278
279div.hdlist {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]280 margin-top: 0.8em;
281 margin-bottom: 0.8em;
282}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]283div.hdlist tr {
284 padding-bottom: 15px;
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]285}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]286dt.hdlist1.strong, td.hdlist1.strong {
287 font-weight: bold;
288}
289td.hdlist1 {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]290 vertical-align: top;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]291 font-style: normal;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]292 padding-right: 0.8em;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]293 color: navy;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]294}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]295td.hdlist2 {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]296 vertical-align: top;
297}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]298div.hdlist.compact tr {
299 margin: 0;
300 padding-bottom: 0;
301}
302
303.comment {
304 background: yellow;
305}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]306
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]307.footnote, .footnoteref {
308 font-size: 0.8em;
309}
310
311span.footnote, span.footnoteref {
312 vertical-align: super;
313}
314
315#footnotes {
316 margin: 20px 0 20px 0;
317 padding: 7px 0 0 0;
318}
319
320#footnotes div.footnote {
321 margin: 0 0 5px 0;
322}
323
324#footnotes hr {
325 border: none;
326 border-top: 1px solid silver;
327 height: 1px;
328 text-align: left;
329 margin-left: 0;
330 width: 20%;
331 min-width: 100px;
332}
333
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]334div.colist td {
335 padding-right: 0.5em;
336 padding-bottom: 0.3em;
337 vertical-align: top;
338}
339div.colist td img {
340 margin-top: 0.3em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]341}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]342
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]343@media print {
344 #footer-badges { display: none; }
345}
346
347#toc {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]348 margin-bottom: 2.5em;
349}
350
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]351#toctitle {
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]352 color: #527bbd;
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]353 font-size: 1.1em;
354 font-weight: bold;
355 margin-top: 1.0em;
356 margin-bottom: 0.1em;
357}
358
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]359div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]360 margin-top: 0;
361 margin-bottom: 0;
362}
363div.toclevel2 {
364 margin-left: 2em;
365 font-size: 0.9em;
366}
367div.toclevel3 {
368 margin-left: 4em;
369 font-size: 0.9em;
370}
371div.toclevel4 {
372 margin-left: 6em;
373 font-size: 0.9em;
374}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]375
376span.aqua { color: aqua; }
377span.black { color: black; }
378span.blue { color: blue; }
379span.fuchsia { color: fuchsia; }
380span.gray { color: gray; }
381span.green { color: green; }
382span.lime { color: lime; }
383span.maroon { color: maroon; }
384span.navy { color: navy; }
385span.olive { color: olive; }
386span.purple { color: purple; }
387span.red { color: red; }
388span.silver { color: silver; }
389span.teal { color: teal; }
390span.white { color: white; }
391span.yellow { color: yellow; }
392
393span.aqua-background { background: aqua; }
394span.black-background { background: black; }
395span.blue-background { background: blue; }
396span.fuchsia-background { background: fuchsia; }
397span.gray-background { background: gray; }
398span.green-background { background: green; }
399span.lime-background { background: lime; }
400span.maroon-background { background: maroon; }
401span.navy-background { background: navy; }
402span.olive-background { background: olive; }
403span.purple-background { background: purple; }
404span.red-background { background: red; }
405span.silver-background { background: silver; }
406span.teal-background { background: teal; }
407span.white-background { background: white; }
408span.yellow-background { background: yellow; }
409
410span.big { font-size: 2em; }
411span.small { font-size: 0.6em; }
412
413span.underline { text-decoration: underline; }
414span.overline { text-decoration: overline; }
415span.line-through { text-decoration: line-through; }
416
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]417div.unbreakable { page-break-inside: avoid; }
418
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]419
420/*
421 * xhtml11 specific
422 *
423 * */
424
425div.tableblock {
426 margin-top: 1.0em;
427 margin-bottom: 1.5em;
428}
429div.tableblock > table {
430 border: 3px solid #527bbd;
431}
432thead, p.table.header {
433 font-weight: bold;
434 color: #527bbd;
435}
436p.table {
437 margin-top: 0;
438}
Junio C Hamano725b0da2020-01-22 22:02:40[diff] [blame]439/* Because the table frame attribute is overridden by CSS in most browsers. */
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]440div.tableblock > table[frame="void"] {
441 border-style: none;
442}
443div.tableblock > table[frame="hsides"] {
444 border-left-style: none;
445 border-right-style: none;
446}
447div.tableblock > table[frame="vsides"] {
448 border-top-style: none;
449 border-bottom-style: none;
450}
451
452
453/*
454 * html5 specific
455 *
456 * */
457
458table.tableblock {
459 margin-top: 1.0em;
460 margin-bottom: 1.5em;
461}
462thead, p.tableblock.header {
463 font-weight: bold;
464 color: #527bbd;
465}
466p.tableblock {
467 margin-top: 0;
468}
469table.tableblock {
470 border-width: 3px;
471 border-spacing: 0px;
472 border-style: solid;
473 border-color: #527bbd;
474 border-collapse: collapse;
475}
476th.tableblock, td.tableblock {
477 border-width: 1px;
478 padding: 4px;
479 border-style: solid;
480 border-color: #527bbd;
481}
482
483table.tableblock.frame-topbot {
484 border-left-style: hidden;
485 border-right-style: hidden;
486}
487table.tableblock.frame-sides {
488 border-top-style: hidden;
489 border-bottom-style: hidden;
490}
491table.tableblock.frame-none {
492 border-style: hidden;
493}
494
495th.tableblock.halign-left, td.tableblock.halign-left {
496 text-align: left;
497}
498th.tableblock.halign-center, td.tableblock.halign-center {
499 text-align: center;
500}
501th.tableblock.halign-right, td.tableblock.halign-right {
502 text-align: right;
503}
504
505th.tableblock.valign-top, td.tableblock.valign-top {
506 vertical-align: top;
507}
508th.tableblock.valign-middle, td.tableblock.valign-middle {
509 vertical-align: middle;
510}
511th.tableblock.valign-bottom, td.tableblock.valign-bottom {
512 vertical-align: bottom;
513}
514
515
516/*
517 * manpage specific
518 *
519 * */
520
521body.manpage h1 {
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]522 padding-top: 0.5em;
523 padding-bottom: 0.5em;
524 border-top: 2px solid silver;
525 border-bottom: 2px solid silver;
526}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]527body.manpage h2 {
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]528 border-style: none;
529}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]530body.manpage div.sectionbody {
531 margin-left: 3em;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]532}
533
534@media print {
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]535 body.manpage div#toc { display: none; }
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]536}
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]537
538
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]539</style>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]540<script type="text/javascript">
541/*<![CDATA[*/
Junio C Hamano2b153182021-12-15 21:00:31[diff] [blame]542var asciidoc = { // Namespace.
543
544/////////////////////////////////////////////////////////////////////
545// Table Of Contents generator
546/////////////////////////////////////////////////////////////////////
547
548/* Author: Mihai Bazon, September 2002
549 * http://students.infoiasi.ro/~mishoo
550 *
551 * Table Of Content generator
552 * Version: 0.4
553 *
554 * Feel free to use this script under the terms of the GNU General Public
555 * License, as long as you do not remove or alter this notice.
556 */
557
558 /* modified by Troy D. Hanson, September 2006. License: GPL */
559 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
560
561// toclevels = 1..4.
562toc: function (toclevels) {
563
564 function getText(el) {
565 var text = "";
566 for (var i = el.firstChild; i != null; i = i.nextSibling) {
567 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
568 text += i.data;
569 else if (i.firstChild != null)
570 text += getText(i);
571 }
572 return text;
573 }
574
575 function TocEntry(el, text, toclevel) {
576 this.element = el;
577 this.text = text;
578 this.toclevel = toclevel;
579 }
580
581 function tocEntries(el, toclevels) {
582 var result = new Array;
583 var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
584 // Function that scans the DOM tree for header elements (the DOM2
585 // nodeIterator API would be a better technique but not supported by all
586 // browsers).
587 var iterate = function (el) {
588 for (var i = el.firstChild; i != null; i = i.nextSibling) {
589 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
590 var mo = re.exec(i.tagName);
591 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
592 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
593 }
594 iterate(i);
595 }
596 }
597 }
598 iterate(el);
599 return result;
600 }
601
602 var toc = document.getElementById("toc");
603 if (!toc) {
604 return;
605 }
606
607 // Delete existing TOC entries in case we're reloading the TOC.
608 var tocEntriesToRemove = [];
609 var i;
610 for (i = 0; i < toc.childNodes.length; i++) {
611 var entry = toc.childNodes[i];
612 if (entry.nodeName.toLowerCase() == 'div'
613 && entry.getAttribute("class")
614 && entry.getAttribute("class").match(/^toclevel/))
615 tocEntriesToRemove.push(entry);
616 }
617 for (i = 0; i < tocEntriesToRemove.length; i++) {
618 toc.removeChild(tocEntriesToRemove[i]);
619 }
620
621 // Rebuild TOC entries.
622 var entries = tocEntries(document.getElementById("content"), toclevels);
623 for (var i = 0; i < entries.length; ++i) {
624 var entry = entries[i];
625 if (entry.element.id == "")
626 entry.element.id = "_toc_" + i;
627 var a = document.createElement("a");
628 a.href = "#" + entry.element.id;
629 a.appendChild(document.createTextNode(entry.text));
630 var div = document.createElement("div");
631 div.appendChild(a);
632 div.className = "toclevel" + entry.toclevel;
633 toc.appendChild(div);
634 }
635 if (entries.length == 0)
636 toc.parentNode.removeChild(toc);
637},
638
639
640/////////////////////////////////////////////////////////////////////
641// Footnotes generator
642/////////////////////////////////////////////////////////////////////
643
644/* Based on footnote generation code from:
645 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
646 */
647
648footnotes: function () {
649 // Delete existing footnote entries in case we're reloading the footnodes.
650 var i;
651 var noteholder = document.getElementById("footnotes");
652 if (!noteholder) {
653 return;
654 }
655 var entriesToRemove = [];
656 for (i = 0; i < noteholder.childNodes.length; i++) {
657 var entry = noteholder.childNodes[i];
658 if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
659 entriesToRemove.push(entry);
660 }
661 for (i = 0; i < entriesToRemove.length; i++) {
662 noteholder.removeChild(entriesToRemove[i]);
663 }
664
665 // Rebuild footnote entries.
666 var cont = document.getElementById("content");
667 var spans = cont.getElementsByTagName("span");
668 var refs = {};
669 var n = 0;
670 for (i=0; i<spans.length; i++) {
671 if (spans[i].className == "footnote") {
672 n++;
673 var note = spans[i].getAttribute("data-note");
674 if (!note) {
675 // Use [\s\S] in place of . so multi-line matches work.
676 // Because JavaScript has no s (dotall) regex flag.
677 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
678 spans[i].innerHTML =
679 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
680 "' title='View footnote' class='footnote'>" + n + "</a>]";
681 spans[i].setAttribute("data-note", note);
682 }
683 noteholder.innerHTML +=
684 "<div class='footnote' id='_footnote_" + n + "'>" +
685 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
686 n + "</a>. " + note + "</div>";
687 var id =spans[i].getAttribute("id");
688 if (id != null) refs["#"+id] = n;
689 }
690 }
691 if (n == 0)
692 noteholder.parentNode.removeChild(noteholder);
693 else {
694 // Process footnoterefs.
695 for (i=0; i<spans.length; i++) {
696 if (spans[i].className == "footnoteref") {
697 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
698 href = href.match(/#.*/)[0]; // Because IE return full URL.
699 n = refs[href];
700 spans[i].innerHTML =
701 "[<a href='#_footnote_" + n +
702 "' title='View footnote' class='footnote'>" + n + "</a>]";
703 }
704 }
705 }
706},
707
708install: function(toclevels) {
709 var timerId;
710
711 function reinstall() {
712 asciidoc.footnotes();
713 if (toclevels) {
714 asciidoc.toc(toclevels);
715 }
716 }
717
718 function reinstallAndRemoveTimer() {
719 clearInterval(timerId);
720 reinstall();
721 }
722
723 timerId = setInterval(reinstall, 500);
724 if (document.addEventListener)
725 document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
726 else
727 window.onload = reinstallAndRemoveTimer;
728}
729
730}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]731asciidoc.install();
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]732/*]]>*/
733</script>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]734</head>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]735<body class="manpage">
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]736<div id="header">
737<h1>
738git-pack-objects(1) Manual Page
739</h1>
740<h2>NAME</h2>
741<div class="sectionbody">
742<p>git-pack-objects -
Junio C Hamano01078922006-03-10 00:31:47[diff] [blame]743 Create a packed archive of objects
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]744</p>
745</div>
746</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]747<div id="content">
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]748<div class="sect1">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]749<h2 id="_synopsis">SYNOPSIS</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]750<div class="sectionbody">
Junio C Hamano7e9f6b72006-02-22 10:44:55[diff] [blame]751<div class="verseblock">
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]752<pre class="content"><em>git pack-objects</em> [-q | --progress | --all-progress] [--all-progress-implied]
Junio C Hamano5706e0b2009-11-24 10:54:16[diff] [blame]753 [--no-reuse-delta] [--delta-base-offset] [--non-empty]
Junio C Hamanod2179ef2010-10-22 04:12:17[diff] [blame]754 [--local] [--incremental] [--window=&lt;n&gt;] [--depth=&lt;n&gt;]
Junio C Hamanob9d9d902018-05-23 07:07:42[diff] [blame]755 [--revs [--unpacked | --all]] [--keep-pack=&lt;pack-name&gt;]
Junio C Hamanoc926f622022-06-03 22:26:23[diff] [blame]756 [--cruft] [--cruft-expiration=&lt;time&gt;]
Junio C Hamano59a32b02021-12-10 22:53:38[diff] [blame]757 [--stdout [--filter=&lt;filter-spec&gt;] | &lt;base-name&gt;]
758 [--shallow] [--keep-true-parents] [--[no-]sparse] &lt; &lt;object-list&gt;</pre>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]759<div class="attribution">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]760</div></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]761</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]762</div>
763<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]764<h2 id="_description">DESCRIPTION</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]765<div class="sectionbody">
Junio C Hamanofb1fdf12017-08-27 06:14:59[diff] [blame]766<div class="paragraph"><p>Reads list of objects from the standard input, and writes either one or
767more packed archives with the specified base-name to disk, or a packed
768archive to the standard output.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]769<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]770between two repositories as well as an access efficient archival
771format. In a packed archive, an object is either stored as a
772compressed whole or as a difference from some other object.
773The latter is often called a delta.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]774<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]775so that it can be unpacked without any further information. Therefore,
776each object that a delta depends upon must be present within the pack.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]777<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]778objects in the pack. Placing both the index file (.idx) and the packed
779archive (.pack) in the pack/ subdirectory of $GIT_OBJECT_DIRECTORY (or
Junio C Hamano9810d632007-09-24 01:05:34[diff] [blame]780any of the directories on $GIT_ALTERNATE_OBJECT_DIRECTORIES)
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]781enables Git to read from the pack archive.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]782<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]783expand the objects contained in the pack into "one-file
784one-object" format; this is typically done by the smart-pull
785commands when a pack is created on-the-fly for efficient network
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]786transport by their peers.</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]787</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]788</div>
789<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]790<h2 id="_options">OPTIONS</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]791<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]792<div class="dlist"><dl>
793<dt class="hdlist1">
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]794base-name
795</dt>
796<dd>
797<p>
Junio C Hamanofb1fdf12017-08-27 06:14:59[diff] [blame]798 Write into pairs of files (.pack and .idx), using
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]799 &lt;base-name&gt; to determine the name of the created file.
Junio C Hamanofb1fdf12017-08-27 06:14:59[diff] [blame]800 When this option is used, the two files in a pair are written in
Junio C Hamanoe3f080d2013-04-22 02:27:13[diff] [blame]801 &lt;base-name&gt;-&lt;SHA-1&gt;.{pack,idx} files. &lt;SHA-1&gt; is a hash
Junio C Hamanob1acf022013-12-28 00:33:16[diff] [blame]802 based on the pack content and is written to the standard
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]803 output of the command.
804</p>
805</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]806<dt class="hdlist1">
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]807--stdout
808</dt>
809<dd>
810<p>
Junio C Hamano235a91e2006-01-07 01:13:58[diff] [blame]811 Write the pack contents (what would have been written to
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]812 .pack file) out to the standard output.
813</p>
814</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]815<dt class="hdlist1">
Junio C Hamano3eb513f2006-09-18 02:47:16[diff] [blame]816--revs
817</dt>
818<dd>
819<p>
820 Read the revision arguments from the standard input, instead of
821 individual object names. The revision arguments are processed
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]822 the same way as <em>git rev-list</em> with the <code>--objects</code> flag
823 uses its <code>commit</code> arguments to build the list of objects it
Junio C Hamano3eb513f2006-09-18 02:47:16[diff] [blame]824 outputs. The objects on the resulting list are packed.
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]825 Besides revisions, <code>--not</code> or <code>--shallow &lt;SHA-1&gt;</code> lines are
Junio C Hamano7c59c672014-03-21 22:08:31[diff] [blame]826 also accepted.
Junio C Hamano3eb513f2006-09-18 02:47:16[diff] [blame]827</p>
828</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]829<dt class="hdlist1">
Junio C Hamano3eb513f2006-09-18 02:47:16[diff] [blame]830--unpacked
831</dt>
832<dd>
833<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]834 This implies <code>--revs</code>. When processing the list of
Junio C Hamano3eb513f2006-09-18 02:47:16[diff] [blame]835 revision arguments read from the standard input, limit
836 the objects packed to those that are not already packed.
837</p>
838</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]839<dt class="hdlist1">
Junio C Hamano3eb513f2006-09-18 02:47:16[diff] [blame]840--all
841</dt>
842<dd>
843<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]844 This implies <code>--revs</code>. In addition to the list of
Junio C Hamano3eb513f2006-09-18 02:47:16[diff] [blame]845 revision arguments read from the standard input, pretend
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]846 as if all refs under <code>refs/</code> are specified to be
Junio C Hamano3eb513f2006-09-18 02:47:16[diff] [blame]847 included.
848</p>
849</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]850<dt class="hdlist1">
Junio C Hamanobb343172008-03-09 10:39:09[diff] [blame]851--include-tag
852</dt>
853<dd>
854<p>
855 Include unasked-for annotated tags if the object they
856 reference was included in the resulting packfile. This
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]857 can be useful to send new tags to native Git clients.
Junio C Hamanobb343172008-03-09 10:39:09[diff] [blame]858</p>
859</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]860<dt class="hdlist1">
Junio C Hamano4d119a12021-03-24 22:19:22[diff] [blame]861--stdin-packs
862</dt>
863<dd>
864<p>
865 Read the basenames of packfiles (e.g., <code>pack-1234abcd.pack</code>)
866 from the standard input, instead of object names or revision
867 arguments. The resulting pack contains all objects listed in the
868 included packs (those not beginning with <code>^</code>), excluding any
869 objects listed in the excluded packs (beginning with <code>^</code>).
870</p>
871<div class="paragraph"><p>Incompatible with <code>--revs</code>, or options that imply <code>--revs</code> (such as
872<code>--all</code>), with the exception of <code>--unpacked</code>, which is compatible.</p></div>
873</dd>
874<dt class="hdlist1">
Junio C Hamanoc926f622022-06-03 22:26:23[diff] [blame]875--cruft
876</dt>
877<dd>
878<p>
879 Packs unreachable objects into a separate "cruft" pack, denoted
880 by the existence of a <code>.mtimes</code> file. Typically used by <code>git
881 repack --cruft</code>. Callers provide a list of pack names and
882 indicate which packs will remain in the repository, along with
883 which packs will be deleted (indicated by the <code>-</code> prefix). The
884 contents of the cruft pack are all objects not contained in the
885 surviving packs which have not exceeded the grace period (see
886 <code>--cruft-expiration</code> below), or which have exceeded the grace
887 period, but are reachable from an other object which hasn&#8217;t.
888</p>
889<div class="paragraph"><p>When the input lists a pack containing all reachable objects (and lists
890all other packs as pending deletion), the corresponding cruft pack will
891contain all unreachable objects (with mtime newer than the
892<code>--cruft-expiration</code>) along with any unreachable objects whose mtime is
893older than the <code>--cruft-expiration</code>, but are reachable from an
894unreachable object whose mtime is newer than the <code>--cruft-expiration</code>).</p></div>
895<div class="paragraph"><p>Incompatible with <code>--unpack-unreachable</code>, <code>--keep-unreachable</code>,
896<code>--pack-loose-unreachable</code>, <code>--stdin-packs</code>, as well as any other
Junio C Hamano5730fe52023-09-07 22:14:06[diff] [blame]897options which imply <code>--revs</code>.</p></div>
Junio C Hamanoc926f622022-06-03 22:26:23[diff] [blame]898</dd>
899<dt class="hdlist1">
900--cruft-expiration=&lt;approxidate&gt;
901</dt>
902<dd>
903<p>
904 If specified, objects are eliminated from the cruft pack if they
905 have an mtime older than <code>&lt;approxidate&gt;</code>. If unspecified (and
906 given <code>--cruft</code>), then no objects are eliminated.
907</p>
908</dd>
909<dt class="hdlist1">
Junio C Hamanod2179ef2010-10-22 04:12:17[diff] [blame]910--window=&lt;n&gt;
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]911</dt>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]912<dt class="hdlist1">
Junio C Hamanod2179ef2010-10-22 04:12:17[diff] [blame]913--depth=&lt;n&gt;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]914</dt>
915<dd>
916<p>
Junio C Hamano93567a62006-10-08 08:47:56[diff] [blame]917 These two options affect how the objects contained in
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]918 the pack are stored using delta compression. The
919 objects are first internally sorted by type, size and
920 optionally names and compared against the other objects
921 within --window to see if using delta compression saves
922 space. --depth limits the maximum delta depth; making
923 it too deep affects the performance on the unpacker
924 side, because delta data needs to be applied that many
925 times to get to the necessary object.
926</p>
Junio C Hamanob9d9d902018-05-23 07:07:42[diff] [blame]927<div class="paragraph"><p>The default value for --window is 10 and --depth is 50. The maximum
928depth is 4095.</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]929</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]930<dt class="hdlist1">
Junio C Hamanod2179ef2010-10-22 04:12:17[diff] [blame]931--window-memory=&lt;n&gt;
Junio C Hamano235d53f2007-07-13 00:25:15[diff] [blame]932</dt>
933<dd>
934<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]935 This option provides an additional limit on top of <code>--window</code>;
Junio C Hamano235d53f2007-07-13 00:25:15[diff] [blame]936 the window size will dynamically scale down so as to not take
Junio C Hamanod2179ef2010-10-22 04:12:17[diff] [blame]937 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]938 repositories with a mix of large and small objects to not run
939 out of memory with a large window, but still be able to take
940 advantage of the large window for the smaller objects. The
941 size can be suffixed with "k", "m", or "g".
Junio C Hamano0f1d17c2016-08-12 19:42:26[diff] [blame]942 <code>--window-memory=0</code> makes memory usage unlimited. The default
943 is taken from the <code>pack.windowMemory</code> configuration variable.
Junio C Hamano235d53f2007-07-13 00:25:15[diff] [blame]944</p>
945</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]946<dt class="hdlist1">
Junio C Hamanod2179ef2010-10-22 04:12:17[diff] [blame]947--max-pack-size=&lt;n&gt;
Junio C Hamano591dc6a2007-05-29 09:18:19[diff] [blame]948</dt>
949<dd>
950<p>
Junio C Hamanofb1fdf12017-08-27 06:14:59[diff] [blame]951 In unusual scenarios, you may not be able to create files
952 larger than a certain size on your filesystem, and this option
953 can be used to tell the command to split the output packfile
954 into multiple independent packfiles, each not larger than the
955 given size. The size can be suffixed with
Junio C Hamano4d979582010-02-04 06:27:29[diff] [blame]956 "k", "m", or "g". The minimum size allowed is limited to 1 MiB.
Junio C Hamano49dccaf2008-02-10 10:48:01[diff] [blame]957 The default is unlimited, unless the config variable
Junio C Hamano91a411f2021-07-14 00:40:50[diff] [blame]958 <code>pack.packSizeLimit</code> is set. Note that this option may result in
959 a larger and slower repository; see the discussion in
960 <code>pack.packSizeLimit</code>.
Junio C Hamano591dc6a2007-05-29 09:18:19[diff] [blame]961</p>
962</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]963<dt class="hdlist1">
Junio C Hamano28363492008-11-14 08:26:31[diff] [blame]964--honor-pack-keep
965</dt>
966<dd>
967<p>
968 This flag causes an object already in a local pack that
Junio C Hamano3eee5872011-04-13 22:40:23[diff] [blame]969 has a .keep file to be ignored, even if it would have
Junio C Hamano636c8b22010-03-07 22:25:17[diff] [blame]970 otherwise been packed.
Junio C Hamano28363492008-11-14 08:26:31[diff] [blame]971</p>
972</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]973<dt class="hdlist1">
Junio C Hamanob9d9d902018-05-23 07:07:42[diff] [blame]974--keep-pack=&lt;pack-name&gt;
975</dt>
976<dd>
977<p>
978 This flag causes an object already in the given pack to be
979 ignored, even if it would have otherwise been
Junio C Hamano556b57e2019-08-12 17:46:38[diff] [blame]980 packed. <code>&lt;pack-name&gt;</code> is the pack file name without
Junio C Hamanob9d9d902018-05-23 07:07:42[diff] [blame]981 leading directory (e.g. <code>pack-123.pack</code>). The option could be
982 specified multiple times to keep multiple packs.
983</p>
984</dd>
985<dt class="hdlist1">
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]986--incremental
987</dt>
988<dd>
989<p>
Junio C Hamano636c8b22010-03-07 22:25:17[diff] [blame]990 This flag causes an object already in a pack to be ignored
991 even if it would have otherwise been packed.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]992</p>
993</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]994<dt class="hdlist1">
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]995--local
996</dt>
997<dd>
998<p>
Junio C Hamano636c8b22010-03-07 22:25:17[diff] [blame]999 This flag causes an object that is borrowed from an alternate
1000 object store to be ignored even if it would have otherwise been
1001 packed.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1002</p>
1003</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1004<dt class="hdlist1">
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1005--non-empty
1006</dt>
1007<dd>
1008<p>
1009 Only create a packed archive if it would contain at
1010 least one object.
1011</p>
1012</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1013<dt class="hdlist1">
Junio C Hamano0d3c8152006-11-08 01:33:41[diff] [blame]1014--progress
1015</dt>
1016<dd>
1017<p>
1018 Progress status is reported on the standard error stream
1019 by default when it is attached to a terminal, unless -q
1020 is specified. This flag forces progress status even if
1021 the standard error stream is not directed to a terminal.
1022</p>
1023</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1024<dt class="hdlist1">
Junio C Hamano0d3c8152006-11-08 01:33:41[diff] [blame]1025--all-progress
1026</dt>
1027<dd>
1028<p>
1029 When --stdout is specified then progress report is
Junio C Hamano5706e0b2009-11-24 10:54:16[diff] [blame]1030 displayed during the object count and compression phases
Junio C Hamano0d3c8152006-11-08 01:33:41[diff] [blame]1031 but inhibited during the write-out phase. The reason is
1032 that in some cases the output stream is directly linked
1033 to another command which may wish to display progress
1034 status of its own as it processes incoming pack data.
1035 This flag is like --progress except that it forces progress
1036 report for the write-out phase as well even if --stdout is
1037 used.
1038</p>
1039</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1040<dt class="hdlist1">
Junio C Hamano5706e0b2009-11-24 10:54:16[diff] [blame]1041--all-progress-implied
1042</dt>
1043<dd>
1044<p>
1045 This is used to imply --all-progress whenever progress display
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1046 is activated. Unlike --all-progress this flag doesn&#8217;t actually
Junio C Hamano5706e0b2009-11-24 10:54:16[diff] [blame]1047 force any progress display by itself.
1048</p>
1049</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1050<dt class="hdlist1">
Junio C Hamano7e9f6b72006-02-22 10:44:55[diff] [blame]1051-q
1052</dt>
1053<dd>
1054<p>
1055 This flag makes the command not to report its progress
1056 on the standard error stream.
1057</p>
1058</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1059<dt class="hdlist1">
Junio C Hamano7e9f6b72006-02-22 10:44:55[diff] [blame]1060--no-reuse-delta
1061</dt>
1062<dd>
1063<p>
1064 When creating a packed archive in a repository that
1065 has existing packs, the command reuses existing deltas.
1066 This sometimes results in a slightly suboptimal pack.
1067 This flag tells the command not to reuse existing deltas
1068 but compute them from scratch.
1069</p>
1070</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1071<dt class="hdlist1">
Junio C Hamanof2ce2972007-05-20 19:12:09[diff] [blame]1072--no-reuse-object
1073</dt>
1074<dd>
1075<p>
1076 This flag tells the command not to reuse existing object data at all,
1077 including non deltified object, forcing recompression of everything.
1078 This implies --no-reuse-delta. Useful only in the obscure case where
1079 wholesale enforcement of a different compression level on the
1080 packed data is desired.
1081</p>
1082</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1083<dt class="hdlist1">
Junio C Hamanod2179ef2010-10-22 04:12:17[diff] [blame]1084--compression=&lt;n&gt;
Junio C Hamanof2ce2972007-05-20 19:12:09[diff] [blame]1085</dt>
1086<dd>
1087<p>
1088 Specifies compression level for newly-compressed data in the
1089 generated pack. If not specified, pack compression level is
1090 determined first by pack.compression, then by core.compression,
1091 and defaults to -1, the zlib default, if neither is set.
Junio C Hamanoef4c2d12007-09-10 08:11:27[diff] [blame]1092 Add --no-reuse-object if you want to force a uniform compression
1093 level on all data no matter the source.
Junio C Hamanof2ce2972007-05-20 19:12:09[diff] [blame]1094</p>
1095</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1096<dt class="hdlist1">
Junio C Hamano929ab972020-03-29 17:30:31[diff] [blame]1097--[no-]sparse
Junio C Hamano23168ef2019-02-07 07:20:47[diff] [blame]1098</dt>
1099<dd>
1100<p>
Junio C Hamano929ab972020-03-29 17:30:31[diff] [blame]1101 Toggle the "sparse" algorithm to determine which objects to include in
Junio C Hamano23168ef2019-02-07 07:20:47[diff] [blame]1102 the pack, when combined with the "--revs" option. This algorithm
1103 only walks trees that appear in paths that introduce new objects.
1104 This can have significant performance benefits when computing
1105 a pack to send a small change. However, it is possible that extra
1106 objects are added to the pack-file if the included commits contain
Junio C Hamano929ab972020-03-29 17:30:31[diff] [blame]1107 certain types of direct renames. If this option is not included,
1108 it defaults to the value of <code>pack.useSparse</code>, which is true unless
1109 otherwise specified.
Junio C Hamano23168ef2019-02-07 07:20:47[diff] [blame]1110</p>
1111</dd>
1112<dt class="hdlist1">
Junio C Hamano4fdccb22010-02-19 09:58:14[diff] [blame]1113--thin
1114</dt>
1115<dd>
1116<p>
1117 Create a "thin" pack by omitting the common objects between a
1118 sender and a receiver in order to reduce network transfer. This
1119 option only makes sense in conjunction with --stdout.
1120</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1121<div class="paragraph"><p>Note: A thin pack violates the packed archive format by omitting
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]1122required objects and is thus unusable by Git without making it
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]1123self-contained. Use <code>git index-pack --fix-thin</code>
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]1124(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]1125</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1126<dt class="hdlist1">
Junio C Hamano629edff2015-01-12 23:46:02[diff] [blame]1127--shallow
1128</dt>
1129<dd>
1130<p>
1131 Optimize a pack that will be provided to a client with a shallow
1132 repository. This option, combined with --thin, can result in a
1133 smaller pack at the cost of speed.
1134</p>
1135</dd>
1136<dt class="hdlist1">
Junio C Hamano77b7e902006-10-23 07:18:50[diff] [blame]1137--delta-base-offset
1138</dt>
1139<dd>
1140<p>
Junio C Hamano059bca52011-03-30 22:47:46[diff] [blame]1141 A packed archive can express the base object of a delta as
1142 either a 20-byte object name or as an offset in the
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]1143 stream, but ancient versions of Git don&#8217;t understand the
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]1144 latter. By default, <em>git pack-objects</em> only uses the
Junio C Hamano77b7e902006-10-23 07:18:50[diff] [blame]1145 former format for better compatibility. This option
1146 allows the command to use the latter format for
1147 compactness. Depending on the average delta chain
1148 length, this option typically shrinks the resulting
1149 packfile by 3-5 per-cent.
1150</p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]1151<div class="paragraph"><p>Note: Porcelain commands such as <code>git gc</code> (see <a href="git-gc.html">git-gc(1)</a>),
1152<code>git repack</code> (see <a href="git-repack.html">git-repack(1)</a>) pass this option by default
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]1153in modern Git when they put objects in your repository into pack files.
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]1154So does <code>git bundle</code> (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]1155</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1156<dt class="hdlist1">
Junio C Hamano58155b42007-09-15 07:46:14[diff] [blame]1157--threads=&lt;n&gt;
1158</dt>
1159<dd>
1160<p>
1161 Specifies the number of threads to spawn when searching for best
1162 delta matches. This requires that pack-objects be compiled with
1163 pthreads otherwise this option is ignored with a warning.
1164 This is meant to reduce packing time on multiprocessor machines.
1165 The required amount of memory for the delta search window is
1166 however multiplied by the number of threads.
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]1167 Specifying 0 will cause Git to auto-detect the number of CPU&#8217;s
Junio C Hamano24bc09a2008-02-28 00:27:44[diff] [blame]1168 and set the number of threads accordingly.
Junio C Hamano58155b42007-09-15 07:46:14[diff] [blame]1169</p>
1170</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1171<dt class="hdlist1">
Junio C Hamanoe90436a2007-04-22 07:22:13[diff] [blame]1172--index-version=&lt;version&gt;[,&lt;offset&gt;]
1173</dt>
1174<dd>
1175<p>
1176 This is intended to be used by the test suite only. It allows
1177 to force the version for the generated pack index, and to force
1178 64-bit index entries on objects located above the given offset.
1179</p>
1180</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1181<dt class="hdlist1">
Junio C Hamanod594fb62009-07-25 09:09:54[diff] [blame]1182--keep-true-parents
1183</dt>
1184<dd>
1185<p>
1186 With this option, parents that are hidden by grafts are packed
1187 nevertheless.
1188</p>
1189</dd>
Junio C Hamano0f1291d2017-12-27 19:58:35[diff] [blame]1190<dt class="hdlist1">
1191--filter=&lt;filter-spec&gt;
1192</dt>
1193<dd>
1194<p>
1195 Requires <code>--stdout</code>. Omits certain objects (usually blobs) from
1196 the resulting packfile. See <a href="git-rev-list.html">git-rev-list(1)</a> for valid
1197 <code>&lt;filter-spec&gt;</code> forms.
1198</p>
1199</dd>
1200<dt class="hdlist1">
1201--no-filter
1202</dt>
1203<dd>
1204<p>
1205 Turns off any previous <code>--filter=</code> argument.
1206</p>
1207</dd>
1208<dt class="hdlist1">
1209--missing=&lt;missing-action&gt;
1210</dt>
1211<dd>
1212<p>
1213 A debug option to help with future "partial clone" development.
1214 This option specifies how missing objects are handled.
1215</p>
1216<div class="paragraph"><p>The form <em>--missing=error</em> requests that pack-objects stop with an error if
Junio C Hamano98c882d2020-08-13 22:06:57[diff] [blame]1217a missing object is encountered. If the repository is a partial clone, an
1218attempt to fetch missing objects will be made before declaring them missing.
1219This is the default action.</p></div>
Junio C Hamano0f1291d2017-12-27 19:58:35[diff] [blame]1220<div class="paragraph"><p>The form <em>--missing=allow-any</em> will allow object traversal to continue
Junio C Hamano98c882d2020-08-13 22:06:57[diff] [blame]1221if a missing object is encountered. No fetch of a missing object will occur.
1222Missing objects will silently be omitted from the results.</p></div>
Junio C Hamano640779d2018-02-14 01:29:14[diff] [blame]1223<div class="paragraph"><p>The form <em>--missing=allow-promisor</em> is like <em>allow-any</em>, but will only
1224allow object traversal to continue for EXPECTED promisor missing objects.
Junio C Hamano98c882d2020-08-13 22:06:57[diff] [blame]1225No fetch of a missing object will occur. An unexpected missing object will
1226raise an error.</p></div>
Junio C Hamano640779d2018-02-14 01:29:14[diff] [blame]1227</dd>
1228<dt class="hdlist1">
1229--exclude-promisor-objects
1230</dt>
1231<dd>
1232<p>
1233 Omit objects that are known to be in the promisor remote. (This
1234 option has the purpose of operating only on locally created objects,
1235 so that when we repack, we still maintain a distinction between
1236 locally created objects [without .promisor] and objects from the
1237 promisor remote [with .promisor].) This is used with partial clone.
1238</p>
Junio C Hamano0f1291d2017-12-27 19:58:35[diff] [blame]1239</dd>
Junio C Hamanob9d9d902018-05-23 07:07:42[diff] [blame]1240<dt class="hdlist1">
1241--keep-unreachable
1242</dt>
1243<dd>
1244<p>
1245 Objects unreachable from the refs in packs named with
1246 --unpacked= option are added to the resulting pack, in
1247 addition to the reachable objects that are not in packs marked
1248 with *.keep files. This implies <code>--revs</code>.
1249</p>
1250</dd>
1251<dt class="hdlist1">
1252--pack-loose-unreachable
1253</dt>
1254<dd>
1255<p>
1256 Pack unreachable loose objects (and their loose counterparts
1257 removed). This implies <code>--revs</code>.
1258</p>
1259</dd>
1260<dt class="hdlist1">
1261--unpack-unreachable
1262</dt>
1263<dd>
1264<p>
1265 Keep unreachable objects in loose form. This implies <code>--revs</code>.
1266</p>
1267</dd>
Junio C Hamano980e61e2018-09-17 22:45:52[diff] [blame]1268<dt class="hdlist1">
1269--delta-islands
1270</dt>
1271<dd>
1272<p>
1273 Restrict delta matches based on "islands". See DELTA ISLANDS
1274 below.
1275</p>
1276</dd>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1277</dl></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1278</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1279</div>
1280<div class="sect1">
Junio C Hamano980e61e2018-09-17 22:45:52[diff] [blame]1281<h2 id="_delta_islands">DELTA ISLANDS</h2>
1282<div class="sectionbody">
1283<div class="paragraph"><p>When possible, <code>pack-objects</code> tries to reuse existing on-disk deltas to
1284avoid having to search for new ones on the fly. This is an important
1285optimization for serving fetches, because it means the server can avoid
1286inflating most objects at all and just send the bytes directly from
1287disk. This optimization can&#8217;t work when an object is stored as a delta
1288against a base which the receiver does not have (and which we are not
1289already sending). In that case the server "breaks" the delta and has to
1290find a new one, which has a high CPU cost. Therefore it&#8217;s important for
1291performance that the set of objects in on-disk delta relationships match
1292what a client would fetch.</p></div>
1293<div class="paragraph"><p>In a normal repository, this tends to work automatically. The objects
1294are mostly reachable from the branches and tags, and that&#8217;s what clients
1295fetch. Any deltas we find on the server are likely to be between objects
1296the client has or will have.</p></div>
1297<div class="paragraph"><p>But in some repository setups, you may have several related but separate
1298groups of ref tips, with clients tending to fetch those groups
1299independently. For example, imagine that you are hosting several "forks"
1300of a repository in a single shared object store, and letting clients
1301view them as separate repositories through <code>GIT_NAMESPACE</code> or separate
1302repos using the alternates mechanism. A naive repack may find that the
1303optimal delta for an object is against a base that is only found in
1304another fork. But when a client fetches, they will not have the base
1305object, and we&#8217;ll have to find a new delta on the fly.</p></div>
1306<div class="paragraph"><p>A similar situation may exist if you have many refs outside of
1307<code>refs/heads/</code> and <code>refs/tags/</code> that point to related objects (e.g.,
1308<code>refs/pull</code> or <code>refs/changes</code> used by some hosting providers). By
1309default, clients fetch only heads and tags, and deltas against objects
1310found only in those other groups cannot be sent as-is.</p></div>
1311<div class="paragraph"><p>Delta islands solve this problem by allowing you to group your refs into
1312distinct "islands". Pack-objects computes which objects are reachable
1313from which islands, and refuses to make a delta from an object <code>A</code>
1314against a base which is not present in all of <code>A</code>'s islands. This
1315results in slightly larger packs (because we miss some delta
1316opportunities), but guarantees that a fetch of one island will not have
1317to recompute deltas on the fly due to crossing island boundaries.</p></div>
1318<div class="paragraph"><p>When repacking with delta islands the delta window tends to get
1319clogged with candidates that are forbidden by the config. Repacking
1320with a big --window helps (and doesn&#8217;t take as long as it otherwise
1321might because we can reject some object pairs based on islands before
1322doing any computation on the content).</p></div>
1323<div class="paragraph"><p>Islands are configured via the <code>pack.island</code> option, which can be
1324specified multiple times. Each value is a left-anchored regular
1325expressions matching refnames. For example:</p></div>
1326<div class="listingblock">
1327<div class="content">
1328<pre><code>[pack]
1329island = refs/heads/
1330island = refs/tags/</code></pre>
1331</div></div>
1332<div class="paragraph"><p>puts heads and tags into an island (whose name is the empty string; see
1333below for more on naming). Any refs which do not match those regular
1334expressions (e.g., <code>refs/pull/123</code>) is not in any island. Any object
1335which is reachable only from <code>refs/pull/</code> (but not heads or tags) is
1336therefore not a candidate to be used as a base for <code>refs/heads/</code>.</p></div>
1337<div class="paragraph"><p>Refs are grouped into islands based on their "names", and two regexes
1338that produce the same name are considered to be in the same
1339island. The names are computed from the regexes by concatenating any
1340capture groups from the regex, with a <em>-</em> dash in between. (And if
1341there are no capture groups, then the name is the empty string, as in
1342the above example.) This allows you to create arbitrary numbers of
1343islands. Only up to 14 such capture groups are supported though.</p></div>
1344<div class="paragraph"><p>For example, imagine you store the refs for each fork in
1345<code>refs/virtual/ID</code>, where <code>ID</code> is a numeric identifier. You might then
1346configure:</p></div>
1347<div class="listingblock">
1348<div class="content">
1349<pre><code>[pack]
1350island = refs/virtual/([0-9]+)/heads/
1351island = refs/virtual/([0-9]+)/tags/
1352island = refs/virtual/([0-9]+)/(pull)/</code></pre>
1353</div></div>
1354<div class="paragraph"><p>That puts the heads and tags for each fork in their own island (named
1355"1234" or similar), and the pull refs for each go into their own
1356"1234-pull".</p></div>
1357<div class="paragraph"><p>Note that we pick a single island for each regex to go into, using "last
1358one wins" ordering (which allows repo-specific config to take precedence
1359over user-wide config, and so forth).</p></div>
1360</div>
1361</div>
1362<div class="sect1">
Junio C Hamanoa372d5b2021-02-26 01:34:37[diff] [blame]1363<h2 id="_configuration">CONFIGURATION</h2>
1364<div class="sectionbody">
1365<div class="paragraph"><p>Various configuration variables affect packing, see
1366<a href="git-config.html">git-config(1)</a> (search for "pack" and "delta").</p></div>
1367<div class="paragraph"><p>Notably, delta compression is not used on objects larger than the
1368<code>core.bigFileThreshold</code> configuration variable and on files with the
1369attribute <code>delta</code> set to false.</p></div>
1370</div>
1371</div>
1372<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1373<h2 id="_see_also">SEE ALSO</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1374<div class="sectionbody">
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]1375<div class="paragraph"><p><a href="git-rev-list.html">git-rev-list(1)</a>
1376<a href="git-repack.html">git-repack(1)</a>
1377<a href="git-prune-packed.html">git-prune-packed(1)</a></p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1378</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1379</div>
1380<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1381<h2 id="_git">GIT</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1382<div class="sectionbody">
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]1383<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]1384</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]1385</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1386</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]1387<div id="footnotes"><hr /></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1388<div id="footer">
1389<div id="footer-text">
Junio C Hamano2ef0ba32018-01-26 23:13:53[diff] [blame]1390Last updated
Junio C Hamano5730fe52023-09-07 22:14:06[diff] [blame]1391 2023-09-07 15:10:34 PDT
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1392</div>
1393</div>
1394</body>
1395</html>