1 <?xml version=
"1.0" encoding=
"UTF-8"?>
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">
6 <meta http-equiv=
"Content-Type" content=
"application/xhtml+xml; charset=UTF-8" />
7 <meta name=
"generator" content=
"AsciiDoc 10.2.0" />
8 <title>git-index-pack(
1)
</title>
9 <style type=
"text/css">
10 /* Shared CSS for AsciiDoc xhtml11 and html5 backends */
14 font-family: Georgia,serif;
18 h1, h2, h3, h4, h5, h6,
19 div.title, caption.title,
20 thead, p.table.header,
22 #author, #revnumber, #revdate, #revremark,
24 font-family: Arial,Helvetica,sans-serif;
28 margin:
1em
5%
1em
5%;
33 text-decoration: underline;
49 h1, h2, h3, h4, h5, h6 {
57 border-bottom:
2px solid silver;
77 border:
1px solid silver;
88 ul
> li { color: #aaa; }
89 ul
> li
> * { color: black; }
91 .monospaced, code, pre {
92 font-family:
"Courier New", Courier, monospace;
99 white-space: pre-wrap;
109 #revnumber, #revdate, #revremark {
114 border-top:
2px solid silver;
120 padding-bottom:
0.5em;
124 padding-bottom:
0.5em;
129 margin-bottom:
1.5em;
131 div.imageblock, div.exampleblock, div.verseblock,
132 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
133 div.admonitionblock {
135 margin-bottom:
1.5em;
137 div.admonitionblock {
139 margin-bottom:
2.0em;
144 div.content { /* Block element content. */
148 /* Block element titles. */
149 div.title, caption.title {
154 margin-bottom:
0.5em;
160 td div.title:first-child {
163 div.content div.title:first-child {
166 div.content + div.title {
170 div.sidebarblock
> div.content {
172 border:
1px solid #dddddd;
173 border-left:
4px solid #f0f0f0;
177 div.listingblock
> div.content {
178 border:
1px solid #dddddd;
179 border-left:
5px solid #f0f0f0;
184 div.quoteblock, div.verseblock {
188 border-left:
5px solid #f0f0f0;
192 div.quoteblock
> div.attribution {
197 div.verseblock
> pre.content {
198 font-family: inherit;
201 div.verseblock
> div.attribution {
205 /* DEPRECATED: Pre version
8.2.7 verse style literal block. */
206 div.verseblock + div.attribution {
210 div.admonitionblock .icon {
214 text-decoration: underline;
216 padding-right:
0.5em;
218 div.admonitionblock td.content {
220 border-left:
3px solid #dddddd;
223 div.exampleblock
> div.content {
224 border-left:
3px solid #dddddd;
228 div.imageblock div.content { padding-left:
0; }
229 span.image img { border-style: none; vertical-align: text-bottom; }
230 a.image:visited { color: white; }
234 margin-bottom:
0.8em;
247 list-style-position: outside;
250 list-style-type: decimal;
253 list-style-type: lower-alpha;
256 list-style-type: upper-alpha;
259 list-style-type: lower-roman;
262 list-style-type: upper-roman;
265 div.compact ul, div.compact ol,
266 div.compact p, div.compact p,
267 div.compact div, div.compact div {
269 margin-bottom:
0.1em;
281 margin-bottom:
0.8em;
284 padding-bottom:
15px;
286 dt.hdlist1.strong, td.hdlist1.strong {
292 padding-right:
0.8em;
298 div.hdlist.compact tr {
307 .footnote, .footnoteref {
311 span.footnote, span.footnoteref {
312 vertical-align: super;
316 margin:
20px
0 20px
0;
320 #footnotes div.footnote {
326 border-top:
1px solid silver;
335 padding-right:
0.5em;
336 padding-bottom:
0.3em;
344 #footer-badges { display: none; }
348 margin-bottom:
2.5em;
356 margin-bottom:
0.1em;
359 div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
376 span.aqua { color: aqua; }
377 span.black { color: black; }
378 span.blue { color: blue; }
379 span.fuchsia { color: fuchsia; }
380 span.gray { color: gray; }
381 span.green { color: green; }
382 span.lime { color: lime; }
383 span.maroon { color: maroon; }
384 span.navy { color: navy; }
385 span.olive { color: olive; }
386 span.purple { color: purple; }
387 span.red { color: red; }
388 span.silver { color: silver; }
389 span.teal { color: teal; }
390 span.white { color: white; }
391 span.yellow { color: yellow; }
393 span.aqua-background { background: aqua; }
394 span.black-background { background: black; }
395 span.blue-background { background: blue; }
396 span.fuchsia-background { background: fuchsia; }
397 span.gray-background { background: gray; }
398 span.green-background { background: green; }
399 span.lime-background { background: lime; }
400 span.maroon-background { background: maroon; }
401 span.navy-background { background: navy; }
402 span.olive-background { background: olive; }
403 span.purple-background { background: purple; }
404 span.red-background { background: red; }
405 span.silver-background { background: silver; }
406 span.teal-background { background: teal; }
407 span.white-background { background: white; }
408 span.yellow-background { background: yellow; }
410 span.big { font-size:
2em; }
411 span.small { font-size:
0.6em; }
413 span.underline { text-decoration: underline; }
414 span.overline { text-decoration: overline; }
415 span.line-through { text-decoration: line-through; }
417 div.unbreakable { page-break-inside: avoid; }
427 margin-bottom:
1.5em;
429 div.tableblock
> table {
430 border:
3px solid #
527bbd;
432 thead, p.table.header {
439 /* Because the table frame attribute is overridden by CSS in most browsers. */
440 div.tableblock
> table[
frame=
"void"] {
443 div.tableblock
> table[
frame=
"hsides"] {
444 border-left-style: none;
445 border-right-style: none;
447 div.tableblock
> table[
frame=
"vsides"] {
448 border-top-style: none;
449 border-bottom-style: none;
460 margin-bottom:
1.5em;
462 thead, p.tableblock.header {
473 border-color: #
527bbd;
474 border-collapse: collapse;
476 th.tableblock, td.tableblock {
480 border-color: #
527bbd;
483 table.tableblock.frame-topbot {
484 border-left-style: hidden;
485 border-right-style: hidden;
487 table.tableblock.frame-sides {
488 border-top-style: hidden;
489 border-bottom-style: hidden;
491 table.tableblock.frame-none {
492 border-style: hidden;
495 th.tableblock.halign-left, td.tableblock.halign-left {
498 th.tableblock.halign-center, td.tableblock.halign-center {
501 th.tableblock.halign-right, td.tableblock.halign-right {
505 th.tableblock.valign-top, td.tableblock.valign-top {
508 th.tableblock.valign-middle, td.tableblock.valign-middle {
509 vertical-align: middle;
511 th.tableblock.valign-bottom, td.tableblock.valign-bottom {
512 vertical-align: bottom;
523 padding-bottom:
0.5em;
524 border-top:
2px solid silver;
525 border-bottom:
2px solid silver;
530 body.manpage div.sectionbody {
535 body.manpage div#toc { display: none; }
540 <script type=
"text/javascript">
542 var asciidoc = { // Namespace.
544 /////////////////////////////////////////////////////////////////////
545 // Table Of Contents generator
546 /////////////////////////////////////////////////////////////////////
548 /* Author: Mihai Bazon, September
2002
549 * http://students.infoiasi.ro/~mishoo
551 * Table Of Content generator
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.
558 /* modified by Troy D. Hanson, September
2006. License: GPL */
559 /* modified by Stuart Rackham,
2006,
2009. License: GPL */
562 toc: function (toclevels) {
564 function getText(el) {
566 for (var i = el.firstChild; i != null; i = i.nextSibling) {
567 if (i.nodeType ==
3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
569 else if (i.firstChild != null)
575 function TocEntry(el, text, toclevel) {
578 this.toclevel = toclevel;
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
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);
602 var toc = document.getElementById(
"toc");
607 // Delete existing TOC entries in case we're reloading the TOC.
608 var tocEntriesToRemove = [];
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);
617 for (i =
0; i < tocEntriesToRemove.length; i++) {
618 toc.removeChild(tocEntriesToRemove[i]);
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");
632 div.className =
"toclevel" + entry.toclevel;
633 toc.appendChild(div);
635 if (entries.length ==
0)
636 toc.parentNode.removeChild(toc);
640 /////////////////////////////////////////////////////////////////////
641 // Footnotes generator
642 /////////////////////////////////////////////////////////////////////
644 /* Based on footnote generation code from:
645 * http://www.brandspankingnew.net/archive/
2005/
07/format_footnote.html
648 footnotes: function () {
649 // Delete existing footnote entries in case we're reloading the footnodes.
651 var noteholder = document.getElementById(
"footnotes");
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);
661 for (i =
0; i < entriesToRemove.length; i++) {
662 noteholder.removeChild(entriesToRemove[i]);
665 // Rebuild footnote entries.
666 var cont = document.getElementById(
"content");
667 var spans = cont.getElementsByTagName(
"span");
670 for (i=
0; i
<spans.length; i++) {
671 if (spans[i].className ==
"footnote") {
673 var note = spans[i].getAttribute(
"data-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];
679 "[<a id='_footnoteref_" + n +
"' href='#_footnote_" + n +
680 "' title='View footnote' class='footnote'>" + n +
"</a>]";
681 spans[i].setAttribute(
"data-note", note);
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;
692 noteholder.parentNode.removeChild(noteholder);
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.
701 "[<a href='#_footnote_" + n +
702 "' title='View footnote' class='footnote'>" + n +
"</a>]";
708 install: function(toclevels) {
711 function reinstall() {
712 asciidoc.footnotes();
714 asciidoc.toc(toclevels);
718 function reinstallAndRemoveTimer() {
719 clearInterval(timerId);
723 timerId = setInterval(reinstall,
500);
724 if (document.addEventListener)
725 document.addEventListener(
"DOMContentLoaded", reinstallAndRemoveTimer, false);
727 window.onload = reinstallAndRemoveTimer;
735 <body class=
"manpage">
738 git-index-pack(
1) Manual Page
741 <div class=
"sectionbody">
743 Build pack index file for an existing packed archive
749 <h2 id=
"_synopsis">SYNOPSIS
</h2>
750 <div class=
"sectionbody">
751 <div class=
"verseblock">
752 <pre class=
"content"><em>git index-pack
</em> [-v] [-o
<index-file
>] [--[no-]rev-index]
<pack-file
>
753 <em>git index-pack
</em> --stdin [--fix-thin] [--keep] [-v] [-o
<index-file
>]
754 [--[no-]rev-index] [
<pack-file
>]
</pre>
755 <div class=
"attribution">
760 <h2 id=
"_description">DESCRIPTION
</h2>
761 <div class=
"sectionbody">
762 <div class=
"paragraph"><p>Reads a packed archive (.pack) from the specified file,
763 builds a pack index file (.idx) for it, and optionally writes a
764 reverse-index (.rev) for the specified pack. The packed
765 archive, together with the pack index, can then be placed in
766 the objects/pack/ directory of a Git repository.
</p></div>
770 <h2 id=
"_options">OPTIONS
</h2>
771 <div class=
"sectionbody">
772 <div class=
"dlist"><dl>
778 Be verbose about what is going on, including progress status.
782 -o
<index-file
>
786 Write the generated pack index into the specified
787 file. Without this option the name of pack index
788 file is constructed from the name of packed archive
789 file by replacing .pack with .idx (and the program
790 fails if the name of packed archive does not end
799 When this flag is provided, generate a reverse index
800 (a
<code>.rev
</code> file) corresponding to the given pack. If
801 <code>--verify
</code> is given, ensure that the existing
802 reverse index is correct. Takes precedence over
803 <code>pack.writeReverseIndex
</code>.
811 When this flag is provided, the pack is read from stdin
812 instead and a copy is then written to
<pack-file
>. If
813 <pack-file
> is not specified, the pack is written to
814 objects/pack/ directory of the current Git repository with
815 a default name determined from the pack content. If
816 <pack-file
> is not specified consider using --keep to
817 prevent a race condition between this process and
826 Fix a
"thin" pack produced by
<code>git pack-objects --thin
</code> (see
827 <a href=
"git-pack-objects.html">git-pack-objects(
1)
</a> for details) by adding the
828 excluded objects the deltified objects are based on to the
829 pack. This option only makes sense in conjunction with --stdin.
837 Before moving the index into its final destination
838 create an empty .keep file for the associated pack file.
839 This option is usually necessary with --stdin to prevent a
840 simultaneous
<em>git repack
</em> process from deleting
841 the newly constructed pack and index before refs can be
842 updated to use objects contained in the pack.
850 Like --keep, create a .keep file before moving the index into
851 its final destination. However, instead of creating an empty file
852 place
<em><msg
></em> followed by an LF into the .keep file. The
<em><msg
></em>
853 message can later be searched for within all .keep files to
854 locate any which have outlived their usefulness.
858 --index-version=
<version
>[,
<offset
>]
862 This is intended to be used by the test suite only. It allows
863 to force the version for the generated pack index, and to force
864 64-bit index entries on objects located above the given offset.
868 --strict[=
<msg-id
>=
<severity
>…]
872 Die, if the pack contains broken objects or links. An optional
873 comma-separated list of
<code><msg-id
>=
<severity
></code> can be passed to change
874 the severity of some possible issues, e.g.,
875 <code>--strict=
"missingEmail=ignore,badTagName=error"</code>. See the entry for the
876 <code>fsck.
<msg-id
></code> configuration options in
<a href=
"git-fsck.html">git-fsck(
1)
</a> for more
877 information on the possible values of
<code><msg-id
></code> and
<code><severity
></code>.
885 For internal use only.
887 <div class=
"paragraph"><p>Set the title of the progress bar. The title is
"Receiving objects" by
888 default and
"Indexing objects" when
<code>--stdin
</code> is specified.
</p></div>
891 --check-self-contained-and-connected
895 Die if the pack contains broken links. For internal use only.
899 --fsck-objects[=
<msg-id
>=
<severity
>…]
903 Die if the pack contains broken objects, but unlike
<code>--strict
</code>, don
’t
904 choke on broken links. If the pack contains a tree pointing to a
905 .gitmodules blob that does not exist, prints the hash of that blob
906 (for the caller to check) after the hash that goes into the name of the
907 pack/idx file (see
"Notes").
909 <div class=
"paragraph"><p>An optional comma-separated list of
<code><msg-id
>=
<severity
></code> can be passed to
910 change the severity of some possible issues, e.g.,
911 <code>--fsck-objects=
"missingEmail=ignore,badTagName=ignore"</code>. See the entry for the
912 <code>fsck.
<msg-id
></code> configuration options in
<a href=
"git-fsck.html">git-fsck(
1)
</a> for more
913 information on the possible values of
<code><msg-id
></code> and
<code><severity
></code>.
</p></div>
920 Specifies the number of threads to spawn when resolving
921 deltas. This requires that index-pack be compiled with
922 pthreads otherwise this option is ignored with a warning.
923 This is meant to reduce packing time on multiprocessor
924 machines. The required amount of memory for the delta search
925 window is however multiplied by the number of threads.
926 Specifying
0 will cause Git to auto-detect the number of CPU
’s
927 and use maximum
3 threads.
931 --max-input-size=
<size
>
935 Die, if the pack is larger than
<size
>.
939 --object-format=
<hash-algorithm
>
943 Specify the given object format (hash algorithm) for the pack. The valid
944 values are
<em>sha1
</em> and (if enabled)
<em>sha256
</em>. The default is the algorithm for
945 the current repository (set by
<code>extensions.objectFormat
</code>), or
<em>sha1
</em> if no
946 value is set or outside a repository.
948 <div class=
"paragraph"><p>This option cannot be used with --stdin.
</p></div>
949 <div class=
"paragraph"><p>Note: At present, there is no interoperability between SHA-
256
950 repositories and SHA-
1 repositories.
</p></div>
953 <div class=
"paragraph"><p>Historically, we warned that SHA-
256 repositories may later need
954 backward incompatible changes when we introduce such interoperability
955 features. Today, we only expect compatible changes. Furthermore, if such
956 changes prove to be necessary, it can be expected that SHA-
256 repositories
957 created with today
’s Git will be usable by future versions of Git
958 without data loss.
</p></div>
959 <div class=
"dlist"><dl>
961 --promisor[=
<message
>]
965 Before committing the pack-index, create a .promisor file for this
966 pack. Particularly helpful when writing a promisor pack with --fix-thin
967 since the name of the pack is not final until the pack has been fully
968 written. If a
<code><message
></code> is provided, then that content will be
969 written to the .promisor file for future reference. See
970 <a href=
"technical/partial-clone.html">partial clone
</a> for more information.
977 <h2 id=
"_notes">NOTES
</h2>
978 <div class=
"sectionbody">
979 <div class=
"paragraph"><p>Once the index has been created, the hash that goes into the name of
980 the pack/idx file is printed to stdout. If --stdin was
981 also used then this is prefixed by either
"pack\t", or
"keep\t" if a
982 new .keep file was successfully created. This is useful to remove a
983 .keep file used as a lock to prevent the race with
<em>git repack
</em>
984 mentioned above.
</p></div>
988 <h2 id=
"_git">GIT
</h2>
989 <div class=
"sectionbody">
990 <div class=
"paragraph"><p>Part of the
<a href=
"git.html">git(
1)
</a> suite
</p></div>
994 <div id=
"footnotes"><hr /></div>
996 <div id=
"footer-text">
998 2024-
02-
08 15:
45:
59 PST