OSDN Git Service

Add Git official document to help
[tortoisegit/TortoiseGitJp.git] / doc / source / en / TortoiseGit / git_doc / git-pack-objects.html.xml
1 <?xml version="1.0" encoding="UTF-8"?>\r
2 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">\r
3 \r
4 <article lang="en" id="git-pack-objects(1)">\r
5 <articleinfo>\r
6     <title>git-pack-objects(1)</title>\r
7         <indexterm>\r
8                 <primary>git-pack-objects(1)</primary>\r
9         </indexterm>\r
10 </articleinfo>\r
11 <simplesect id="_name">\r
12 <title>NAME</title>\r
13 <simpara>git-pack-objects - Create a packed archive of objects</simpara>\r
14 </simplesect>\r
15 <simplesect id="_synopsis">\r
16 <title>SYNOPSIS</title>\r
17 <blockquote>\r
18 <literallayout><emphasis>git pack-objects</emphasis> [-q] [--no-reuse-delta] [--delta-base-offset] [--non-empty]\r
19         [--local] [--incremental] [--window=N] [--depth=N] [--all-progress]\r
20         [--revs [--unpacked | --all]*] [--stdout | base-name] &lt; object-list</literallayout>\r
21 </blockquote>\r
22 </simplesect>\r
23 <simplesect id="_description">\r
24 <title>DESCRIPTION</title>\r
25 <simpara>Reads list of objects from the standard input, and writes a packed\r
26 archive with specified base-name, or to the standard output.</simpara>\r
27 <simpara>A packed archive is an efficient way to transfer set of objects\r
28 between two repositories, and also is an archival format which\r
29 is efficient to access.  The packed archive format (.pack) is\r
30 designed to be self contained so that it can be unpacked without\r
31 any further information, but for fast, random access to the objects\r
32 in the pack, a pack index file (.idx) will be generated.</simpara>\r
33 <simpara>Placing both in the pack/ subdirectory of $GIT_OBJECT_DIRECTORY (or\r
34 any of the directories on $GIT_ALTERNATE_OBJECT_DIRECTORIES)\r
35 enables git to read from such an archive.</simpara>\r
36 <simpara>The <emphasis>git-unpack-objects</emphasis> command can read the packed archive and\r
37 expand the objects contained in the pack into "one-file\r
38 one-object" format; this is typically done by the smart-pull\r
39 commands when a pack is created on-the-fly for efficient network\r
40 transport by their peers.</simpara>\r
41 <simpara>In a packed archive, an object is either stored as a compressed\r
42 whole, or as a difference from some other object.  The latter is\r
43 often called a delta.</simpara>\r
44 </simplesect>\r
45 <simplesect id="_options">\r
46 <title>OPTIONS</title>\r
47 <variablelist>\r
48 <varlistentry>\r
49 <term>\r
50 base-name\r
51 </term>\r
52 <listitem>\r
53 <simpara>\r
54         Write into a pair of files (.pack and .idx), using\r
55         &lt;base-name&gt; to determine the name of the created file.\r
56         When this option is used, the two files are written in\r
57         &lt;base-name&gt;-&lt;SHA1&gt;.{pack,idx} files.  &lt;SHA1&gt; is a hash\r
58         of the sorted object names to make the resulting filename\r
59         based on the pack content, and written to the standard\r
60         output of the command.\r
61 </simpara>\r
62 </listitem>\r
63 </varlistentry>\r
64 <varlistentry>\r
65 <term>\r
66 --stdout\r
67 </term>\r
68 <listitem>\r
69 <simpara>\r
70         Write the pack contents (what would have been written to\r
71         .pack file) out to the standard output.\r
72 </simpara>\r
73 </listitem>\r
74 </varlistentry>\r
75 <varlistentry>\r
76 <term>\r
77 --revs\r
78 </term>\r
79 <listitem>\r
80 <simpara>\r
81         Read the revision arguments from the standard input, instead of\r
82         individual object names.  The revision arguments are processed\r
83         the same way as <emphasis>git-rev-list</emphasis> with the <literal>--objects</literal> flag\r
84         uses its <literal>commit</literal> arguments to build the list of objects it\r
85         outputs.  The objects on the resulting list are packed.\r
86 </simpara>\r
87 </listitem>\r
88 </varlistentry>\r
89 <varlistentry>\r
90 <term>\r
91 --unpacked\r
92 </term>\r
93 <listitem>\r
94 <simpara>\r
95         This implies <literal>--revs</literal>.  When processing the list of\r
96         revision arguments read from the standard input, limit\r
97         the objects packed to those that are not already packed.\r
98 </simpara>\r
99 </listitem>\r
100 </varlistentry>\r
101 <varlistentry>\r
102 <term>\r
103 --all\r
104 </term>\r
105 <listitem>\r
106 <simpara>\r
107         This implies <literal>--revs</literal>.  In addition to the list of\r
108         revision arguments read from the standard input, pretend\r
109         as if all refs under <literal>$GIT_DIR/refs</literal> are specified to be\r
110         included.\r
111 </simpara>\r
112 </listitem>\r
113 </varlistentry>\r
114 <varlistentry>\r
115 <term>\r
116 --include-tag\r
117 </term>\r
118 <listitem>\r
119 <simpara>\r
120         Include unasked-for annotated tags if the object they\r
121         reference was included in the resulting packfile.  This\r
122         can be useful to send new tags to native git clients.\r
123 </simpara>\r
124 </listitem>\r
125 </varlistentry>\r
126 <varlistentry>\r
127 <term>\r
128 --window=[N]\r
129 </term>\r
130 <term>\r
131 --depth=[N]\r
132 </term>\r
133 <listitem>\r
134 <simpara>\r
135         These two options affect how the objects contained in\r
136         the pack are stored using delta compression.  The\r
137         objects are first internally sorted by type, size and\r
138         optionally names and compared against the other objects\r
139         within --window to see if using delta compression saves\r
140         space.  --depth limits the maximum delta depth; making\r
141         it too deep affects the performance on the unpacker\r
142         side, because delta data needs to be applied that many\r
143         times to get to the necessary object.\r
144         The default value for --window is 10 and --depth is 50.\r
145 </simpara>\r
146 </listitem>\r
147 </varlistentry>\r
148 <varlistentry>\r
149 <term>\r
150 --window-memory=[N]\r
151 </term>\r
152 <listitem>\r
153 <simpara>\r
154         This option provides an additional limit on top of <literal>--window</literal>;\r
155         the window size will dynamically scale down so as to not take\r
156         up more than N bytes in memory.  This is useful in\r
157         repositories with a mix of large and small objects to not run\r
158         out of memory with a large window, but still be able to take\r
159         advantage of the large window for the smaller objects.  The\r
160         size can be suffixed with "k", "m", or "g".\r
161         <literal>--window-memory=0</literal> makes memory usage unlimited, which is the\r
162         default.\r
163 </simpara>\r
164 </listitem>\r
165 </varlistentry>\r
166 <varlistentry>\r
167 <term>\r
168 --max-pack-size=&lt;n&gt;\r
169 </term>\r
170 <listitem>\r
171 <simpara>\r
172         Maximum size of each output packfile, expressed in MiB.\r
173         If specified,  multiple packfiles may be created.\r
174         The default is unlimited, unless the config variable\r
175         <literal>pack.packSizeLimit</literal> is set.\r
176 </simpara>\r
177 </listitem>\r
178 </varlistentry>\r
179 <varlistentry>\r
180 <term>\r
181 --honor-pack-keep\r
182 </term>\r
183 <listitem>\r
184 <simpara>\r
185         This flag causes an object already in a local pack that\r
186         has a .keep file to be ignored, even if it appears in the\r
187         standard input.\r
188 </simpara>\r
189 </listitem>\r
190 </varlistentry>\r
191 <varlistentry>\r
192 <term>\r
193 --incremental\r
194 </term>\r
195 <listitem>\r
196 <simpara>\r
197         This flag causes an object already in a pack ignored\r
198         even if it appears in the standard input.\r
199 </simpara>\r
200 </listitem>\r
201 </varlistentry>\r
202 <varlistentry>\r
203 <term>\r
204 --local\r
205 </term>\r
206 <listitem>\r
207 <simpara>\r
208         This flag is similar to <literal>--incremental</literal>; instead of\r
209         ignoring all packed objects, it only ignores objects\r
210         that are packed and/or not in the local object store\r
211         (i.e. borrowed from an alternate).\r
212 </simpara>\r
213 </listitem>\r
214 </varlistentry>\r
215 <varlistentry>\r
216 <term>\r
217 --non-empty\r
218 </term>\r
219 <listitem>\r
220 <simpara>\r
221         Only create a packed archive if it would contain at\r
222         least one object.\r
223 </simpara>\r
224 </listitem>\r
225 </varlistentry>\r
226 <varlistentry>\r
227 <term>\r
228 --progress\r
229 </term>\r
230 <listitem>\r
231 <simpara>\r
232         Progress status is reported on the standard error stream\r
233         by default when it is attached to a terminal, unless -q\r
234         is specified. This flag forces progress status even if\r
235         the standard error stream is not directed to a terminal.\r
236 </simpara>\r
237 </listitem>\r
238 </varlistentry>\r
239 <varlistentry>\r
240 <term>\r
241 --all-progress\r
242 </term>\r
243 <listitem>\r
244 <simpara>\r
245         When --stdout is specified then progress report is\r
246         displayed during the object count and deltification phases\r
247         but inhibited during the write-out phase. The reason is\r
248         that in some cases the output stream is directly linked\r
249         to another command which may wish to display progress\r
250         status of its own as it processes incoming pack data.\r
251         This flag is like --progress except that it forces progress\r
252         report for the write-out phase as well even if --stdout is\r
253         used.\r
254 </simpara>\r
255 </listitem>\r
256 </varlistentry>\r
257 <varlistentry>\r
258 <term>\r
259 -q\r
260 </term>\r
261 <listitem>\r
262 <simpara>\r
263         This flag makes the command not to report its progress\r
264         on the standard error stream.\r
265 </simpara>\r
266 </listitem>\r
267 </varlistentry>\r
268 <varlistentry>\r
269 <term>\r
270 --no-reuse-delta\r
271 </term>\r
272 <listitem>\r
273 <simpara>\r
274         When creating a packed archive in a repository that\r
275         has existing packs, the command reuses existing deltas.\r
276         This sometimes results in a slightly suboptimal pack.\r
277         This flag tells the command not to reuse existing deltas\r
278         but compute them from scratch.\r
279 </simpara>\r
280 </listitem>\r
281 </varlistentry>\r
282 <varlistentry>\r
283 <term>\r
284 --no-reuse-object\r
285 </term>\r
286 <listitem>\r
287 <simpara>\r
288         This flag tells the command not to reuse existing object data at all,\r
289         including non deltified object, forcing recompression of everything.\r
290         This implies --no-reuse-delta. Useful only in the obscure case where\r
291         wholesale enforcement of a different compression level on the\r
292         packed data is desired.\r
293 </simpara>\r
294 </listitem>\r
295 </varlistentry>\r
296 <varlistentry>\r
297 <term>\r
298 --compression=[N]\r
299 </term>\r
300 <listitem>\r
301 <simpara>\r
302         Specifies compression level for newly-compressed data in the\r
303         generated pack.  If not specified,  pack compression level is\r
304         determined first by pack.compression,  then by core.compression,\r
305         and defaults to -1,  the zlib default,  if neither is set.\r
306         Add --no-reuse-object if you want to force a uniform compression\r
307         level on all data no matter the source.\r
308 </simpara>\r
309 </listitem>\r
310 </varlistentry>\r
311 <varlistentry>\r
312 <term>\r
313 --delta-base-offset\r
314 </term>\r
315 <listitem>\r
316 <simpara>\r
317         A packed archive can express base object of a delta as\r
318         either 20-byte object name or as an offset in the\r
319         stream, but older version of git does not understand the\r
320         latter.  By default, <emphasis>git-pack-objects</emphasis> only uses the\r
321         former format for better compatibility.  This option\r
322         allows the command to use the latter format for\r
323         compactness.  Depending on the average delta chain\r
324         length, this option typically shrinks the resulting\r
325         packfile by 3-5 per-cent.\r
326 </simpara>\r
327 </listitem>\r
328 </varlistentry>\r
329 <varlistentry>\r
330 <term>\r
331 --threads=&lt;n&gt;\r
332 </term>\r
333 <listitem>\r
334 <simpara>\r
335         Specifies the number of threads to spawn when searching for best\r
336         delta matches.  This requires that pack-objects be compiled with\r
337         pthreads otherwise this option is ignored with a warning.\r
338         This is meant to reduce packing time on multiprocessor machines.\r
339         The required amount of memory for the delta search window is\r
340         however multiplied by the number of threads.\r
341         Specifying 0 will cause git to auto-detect the number of CPU&#8217;s\r
342         and set the number of threads accordingly.\r
343 </simpara>\r
344 </listitem>\r
345 </varlistentry>\r
346 <varlistentry>\r
347 <term>\r
348 --index-version=&lt;version&gt;[,&lt;offset&gt;]\r
349 </term>\r
350 <listitem>\r
351 <simpara>\r
352         This is intended to be used by the test suite only. It allows\r
353         to force the version for the generated pack index, and to force\r
354         64-bit index entries on objects located above the given offset.\r
355 </simpara>\r
356 </listitem>\r
357 </varlistentry>\r
358 </variablelist>\r
359 </simplesect>\r
360 <simplesect id="_author">\r
361 <title>Author</title>\r
362 <simpara>Written by Linus Torvalds &lt;<ulink url="mailto:torvalds@osdl.org">torvalds@osdl.org</ulink>&gt;</simpara>\r
363 </simplesect>\r
364 <simplesect id="_documentation">\r
365 <title>Documentation</title>\r
366 <simpara>Documentation by Junio C Hamano</simpara>\r
367 </simplesect>\r
368 <simplesect id="_see_also">\r
369 <title>SEE ALSO</title>\r
370 <simpara><xref linkend="git-rev-list(1)"/>\r
371 <xref linkend="git-repack(1)"/>\r
372 <xref linkend="git-prune-packed(1)"/></simpara>\r
373 </simplesect>\r
374 <simplesect id="_git">\r
375 <title>GIT</title>\r
376 <simpara>Part of the <xref linkend="git(1)"/> suite</simpara>\r
377 </simplesect>\r
378 </article>\r