OSDN Git Service

Add Git official document to help
[tortoisegit/TortoiseGitJp.git] / doc / source / en / TortoiseGit / git_doc / git-repack.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-repack(1)">\r
5 <articleinfo>\r
6     <title>git-repack(1)</title>\r
7         <indexterm>\r
8                 <primary>git-repack(1)</primary>\r
9         </indexterm>\r
10 </articleinfo>\r
11 <simplesect id="_name">\r
12 <title>NAME</title>\r
13 <simpara>git-repack - Pack unpacked objects in a repository</simpara>\r
14 </simplesect>\r
15 <simplesect id="_synopsis">\r
16 <title>SYNOPSIS</title>\r
17 <simpara><emphasis>git repack</emphasis> [-a] [-A] [-d] [-f] [-l] [-n] [-q] [--window=N] [--depth=N]</simpara>\r
18 </simplesect>\r
19 <simplesect id="_description">\r
20 <title>DESCRIPTION</title>\r
21 <simpara>This script is used to combine all objects that do not currently\r
22 reside in a "pack", into a pack.  It can also be used to re-organize\r
23 existing packs into a single, more efficient pack.</simpara>\r
24 <simpara>A pack is a collection of objects, individually compressed, with\r
25 delta compression applied, stored in a single file, with an\r
26 associated index file.</simpara>\r
27 <simpara>Packs are used to reduce the load on mirror systems, backup\r
28 engines, disk storage, etc.</simpara>\r
29 </simplesect>\r
30 <simplesect id="_options">\r
31 <title>OPTIONS</title>\r
32 <variablelist>\r
33 <varlistentry>\r
34 <term>\r
35 -a\r
36 </term>\r
37 <listitem>\r
38 <simpara>\r
39         Instead of incrementally packing the unpacked objects,\r
40         pack everything referenced into a single pack.\r
41         Especially useful when packing a repository that is used\r
42         for private development and there is no need to worry\r
43         about people fetching via dumb protocols from it.  Use\r
44         with <emphasis>-d</emphasis>.  This will clean up the objects that <literal>git prune</literal>\r
45         leaves behind, but <literal>git fsck --full</literal> shows as\r
46         dangling.\r
47 </simpara>\r
48 </listitem>\r
49 </varlistentry>\r
50 <varlistentry>\r
51 <term>\r
52 -A\r
53 </term>\r
54 <listitem>\r
55 <simpara>\r
56         Same as <literal>-a</literal>, unless <emphasis>-d</emphasis> is used.  Then any unreachable\r
57         objects in a previous pack become loose, unpacked objects,\r
58         instead of being left in the old pack.  Unreachable objects\r
59         are never intentionally added to a pack, even when repacking.\r
60         This option prevents unreachable objects from being immediately\r
61         deleted by way of being left in the old pack and then\r
62         removed.  Instead, the loose unreachable objects\r
63         will be pruned according to normal expiry rules\r
64         with the next <emphasis>git-gc</emphasis> invocation. See <xref linkend="git-gc(1)"/>.\r
65 </simpara>\r
66 </listitem>\r
67 </varlistentry>\r
68 <varlistentry>\r
69 <term>\r
70 -d\r
71 </term>\r
72 <listitem>\r
73 <simpara>\r
74         After packing, if the newly created packs make some\r
75         existing packs redundant, remove the redundant packs.\r
76         Also run  <emphasis>git-prune-packed</emphasis> to remove redundant\r
77         loose object files.\r
78 </simpara>\r
79 </listitem>\r
80 </varlistentry>\r
81 <varlistentry>\r
82 <term>\r
83 -l\r
84 </term>\r
85 <listitem>\r
86 <simpara>\r
87         Pass the <literal>--local</literal> option to <emphasis>git-pack-objects</emphasis>. See\r
88         <xref linkend="git-pack-objects(1)"/>.\r
89 </simpara>\r
90 </listitem>\r
91 </varlistentry>\r
92 <varlistentry>\r
93 <term>\r
94 -f\r
95 </term>\r
96 <listitem>\r
97 <simpara>\r
98         Pass the <literal>--no-reuse-object</literal> option to <literal>git-pack-objects</literal>, see\r
99         <xref linkend="git-pack-objects(1)"/>.\r
100 </simpara>\r
101 </listitem>\r
102 </varlistentry>\r
103 <varlistentry>\r
104 <term>\r
105 -q\r
106 </term>\r
107 <listitem>\r
108 <simpara>\r
109         Pass the <literal>-q</literal> option to <emphasis>git-pack-objects</emphasis>. See\r
110         <xref linkend="git-pack-objects(1)"/>.\r
111 </simpara>\r
112 </listitem>\r
113 </varlistentry>\r
114 <varlistentry>\r
115 <term>\r
116 -n\r
117 </term>\r
118 <listitem>\r
119 <simpara>\r
120         Do not update the server information with\r
121         <emphasis>git-update-server-info</emphasis>.  This option skips\r
122         updating local catalog files needed to publish\r
123         this repository (or a direct copy of it)\r
124         over HTTP or FTP.  See <xref linkend="git-update-server-info(1)"/>.\r
125 </simpara>\r
126 </listitem>\r
127 </varlistentry>\r
128 <varlistentry>\r
129 <term>\r
130 --window=[N]\r
131 </term>\r
132 <term>\r
133 --depth=[N]\r
134 </term>\r
135 <listitem>\r
136 <simpara>\r
137         These two options affect how the objects contained in the pack are\r
138         stored using delta compression. The objects are first internally\r
139         sorted by type, size and optionally names and compared against the\r
140         other objects within <literal>--window</literal> to see if using delta compression saves\r
141         space. <literal>--depth</literal> limits the maximum delta depth; making it too deep\r
142         affects the performance on the unpacker side, because delta data needs\r
143         to be applied that many 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.\r
175 </simpara>\r
176 </listitem>\r
177 </varlistentry>\r
178 </variablelist>\r
179 </simplesect>\r
180 <simplesect id="_configuration">\r
181 <title>Configuration</title>\r
182 <simpara>When configuration variable <literal>repack.UseDeltaBaseOffset</literal> is set\r
183 for the repository, the command passes <literal>--delta-base-offset</literal>\r
184 option to <emphasis>git-pack-objects</emphasis>; this typically results in slightly\r
185 smaller packs, but the generated packs are incompatible with\r
186 versions of git older than (and including) v1.4.3; do not set\r
187 the variable in a repository that older version of git needs to\r
188 be able to read (this includes repositories from which packs can\r
189 be copied out over http or rsync, and people who obtained packs\r
190 that way can try to use older git with it).</simpara>\r
191 </simplesect>\r
192 <simplesect id="_author">\r
193 <title>Author</title>\r
194 <simpara>Written by Linus Torvalds &lt;<ulink url="mailto:torvalds@osdl.org">torvalds@osdl.org</ulink>&gt;</simpara>\r
195 </simplesect>\r
196 <simplesect id="_documentation">\r
197 <title>Documentation</title>\r
198 <simpara>Documentation by Ryan Anderson &lt;<ulink url="mailto:ryan@michonline.com">ryan@michonline.com</ulink>&gt;</simpara>\r
199 </simplesect>\r
200 <simplesect id="_see_also">\r
201 <title>SEE ALSO</title>\r
202 <simpara><xref linkend="git-pack-objects(1)"/>\r
203 <xref linkend="git-prune-packed(1)"/></simpara>\r
204 </simplesect>\r
205 <simplesect id="_git">\r
206 <title>GIT</title>\r
207 <simpara>Part of the <xref linkend="git(1)"/> suite</simpara>\r
208 </simplesect>\r
209 </article>\r