doc/source/en/TortoiseGit/git_doc/git-multi-pack-index.xml

   1 <?xml version="1.0" encoding="UTF-8"?>\r
   2 <!DOCTYPE sect2 SYSTEM "../../../dtd/dblite.dtd">\r
   3 \r
   4 <sect2 lang="en" id="git-multi-pack-index(1)">\r
   5     <title>git-multi-pack-index(1)</title>\r
   6 <indexterm>\r
   7 <primary>git-multi-pack-index(1)</primary>\r
   8 </indexterm>\r
   9 <simplesect id="git-multi-pack-index(1)__name">\r
  10 <title>NAME</title>\r
  11 <simpara>git-multi-pack-index - Write and verify multi-pack-indexes</simpara>\r
  12 </simplesect>\r
  13 <simplesect id="git-multi-pack-index(1)__synopsis">\r
  14 <title>SYNOPSIS</title>\r
  15 <blockquote>\r
  16 <literallayout><emphasis>git multi-pack-index</emphasis> [--object-dir=&lt;dir&gt;] [--[no-]progress] &lt;subcommand&gt;</literallayout>\r
  17 </blockquote>\r
  18 </simplesect>\r
  19 <simplesect id="git-multi-pack-index(1)__description">\r
  20 <title>DESCRIPTION</title>\r
  21 <simpara>Write or verify a multi-pack-index (MIDX) file.</simpara>\r
  22 </simplesect>\r
  23 <simplesect id="git-multi-pack-index(1)__options">\r
  24 <title>OPTIONS</title>\r
  25 <variablelist>\r
  26 <varlistentry>\r
  27 <term>\r
  28 --object-dir=&lt;dir&gt;\r
  29 </term>\r
  30 <listitem>\r
  31 <simpara>\r
  32         Use given directory for the location of Git objects. We check\r
  33         <emphasis>&lt;dir&gt;/packs/multi-pack-index</emphasis> for the current MIDX file, and\r
  34         <emphasis>&lt;dir&gt;/packs</emphasis> for the pack-files to index.\r
  35 </simpara>\r
  36 </listitem>\r
  37 </varlistentry>\r
  38 <varlistentry>\r
  39 <term>\r
  40 --[no-]progress\r
  41 </term>\r
  42 <listitem>\r
  43 <simpara>\r
  44         Turn progress on/off explicitly. If neither is specified, progress is\r
  45         shown if standard error is connected to a terminal.\r
  46 </simpara>\r
  47 </listitem>\r
  48 </varlistentry>\r
  49 </variablelist>\r
  50 <simpara>The following subcommands are available:</simpara>\r
  51 <variablelist>\r
  52 <varlistentry>\r
  53 <term>\r
  54 write\r
  55 </term>\r
  56 <listitem>\r
  57 <simpara>\r
  58         Write a new MIDX file.\r
  59 </simpara>\r
  60 </listitem>\r
  61 </varlistentry>\r
  62 <varlistentry>\r
  63 <term>\r
  64 verify\r
  65 </term>\r
  66 <listitem>\r
  67 <simpara>\r
  68         Verify the contents of the MIDX file.\r
  69 </simpara>\r
  70 </listitem>\r
  71 </varlistentry>\r
  72 <varlistentry>\r
  73 <term>\r
  74 expire\r
  75 </term>\r
  76 <listitem>\r
  77 <simpara>\r
  78         Delete the pack-files that are tracked  by the MIDX file, but\r
  79         have no objects referenced by the MIDX. Rewrite the MIDX file\r
  80         afterward to remove all references to these pack-files.\r
  81 </simpara>\r
  82 </listitem>\r
  83 </varlistentry>\r
  84 <varlistentry>\r
  85 <term>\r
  86 repack\r
  87 </term>\r
  88 <listitem>\r
  89 <simpara>\r
  90         Create a new pack-file containing objects in small pack-files\r
  91         referenced by the multi-pack-index. If the size given by the\r
  92         <emphasis>--batch-size=&lt;size&gt;</emphasis> argument is zero, then create a pack\r
  93         containing all objects referenced by the multi-pack-index. For\r
  94         a non-zero batch size, Select the pack-files by examining packs\r
  95         from oldest-to-newest, computing the "expected size" by counting\r
  96         the number of objects in the pack referenced by the\r
  97         multi-pack-index, then divide by the total number of objects in\r
  98         the pack and multiply by the pack size. We select packs with\r
  99         expected size below the batch size until the set of packs have\r
 100         total expected size at least the batch size. If the total size\r
 101         does not reach the batch size, then do nothing. If a new pack-\r
 102         file is created, rewrite the multi-pack-index to reference the\r
 103         new pack-file. A later run of <emphasis>git multi-pack-index expire</emphasis> will\r
 104         delete the pack-files that were part of this batch.\r
 105 </simpara>\r
 106 <simpara>If <emphasis>repack.packKeptObjects</emphasis> is <emphasis>false</emphasis>, then any pack-files with an\r
 107 associated <emphasis>.keep</emphasis> file will not be selected for the batch to repack.</simpara>\r
 108 </listitem>\r
 109 </varlistentry>\r
 110 </variablelist>\r
 111 </simplesect>\r
 112 <simplesect id="git-multi-pack-index(1)__examples">\r
 113 <title>EXAMPLES</title>\r
 114 <itemizedlist>\r
 115 <listitem>\r
 116 <simpara>\r
 117 Write a MIDX file for the packfiles in the current .git folder.\r
 118 </simpara>\r
 119 <screen>$ git multi-pack-index write</screen>\r
 120 </listitem>\r
 121 <listitem>\r
 122 <simpara>\r
 123 Write a MIDX file for the packfiles in an alternate object store.\r
 124 </simpara>\r
 125 <screen>$ git multi-pack-index --object-dir &lt;alt&gt; write</screen>\r
 126 </listitem>\r
 127 <listitem>\r
 128 <simpara>\r
 129 Verify the MIDX file for the packfiles in the current .git folder.\r
 130 </simpara>\r
 131 <screen>$ git multi-pack-index verify</screen>\r
 132 </listitem>\r
 133 </itemizedlist>\r
 134 </simplesect>\r
 135 <simplesect id="git-multi-pack-index(1)__see_also">\r
 136 <title>SEE ALSO</title>\r
 137 <simpara>See <ulink url="https://www.kernel.org/pub/software/scm/git/docs/technical/multi-pack-index.html"><citetitle>The Multi-Pack-Index Design\r
 138 Document</citetitle></ulink> and <ulink url="https://www.kernel.org/pub/software/scm/git/docs/technical/pack-format.html"><citetitle>The Multi-Pack-Index\r
 139 Format</citetitle></ulink> for more information on the multi-pack-index feature.</simpara>\r
 140 </simplesect>\r
 141 <simplesect id="git-multi-pack-index(1)__git">\r
 142 <title>GIT</title>\r
 143 <simpara>Part of the <xref linkend="git(1)" /> suite</simpara>\r
 144 </simplesect>\r
 145 </sect2>\r