Autogenerated HTML docs for v1.7.4-rc2
[git/jnareb-git.git] / git-prune.html
blob49096579065bd7d1193051eee2ae13e1178a6cb1
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
4 <head>
5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
6 <meta name="generator" content="AsciiDoc 8.2.5" />
7 <style type="text/css">
8 /* Debug borders */
9 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
11 border: 1px solid red;
15 body {
16 margin: 1em 5% 1em 5%;
19 a {
20 color: blue;
21 text-decoration: underline;
23 a:visited {
24 color: fuchsia;
27 em {
28 font-style: italic;
31 strong {
32 font-weight: bold;
35 tt {
36 color: navy;
39 h1, h2, h3, h4, h5, h6 {
40 color: #527bbd;
41 font-family: sans-serif;
42 margin-top: 1.2em;
43 margin-bottom: 0.5em;
44 line-height: 1.3;
47 h1, h2, h3 {
48 border-bottom: 2px solid silver;
50 h2 {
51 padding-top: 0.5em;
53 h3 {
54 float: left;
56 h3 + * {
57 clear: left;
60 div.sectionbody {
61 font-family: serif;
62 margin-left: 0;
65 hr {
66 border: 1px solid silver;
69 p {
70 margin-top: 0.5em;
71 margin-bottom: 0.5em;
74 pre {
75 padding: 0;
76 margin: 0;
79 span#author {
80 color: #527bbd;
81 font-family: sans-serif;
82 font-weight: bold;
83 font-size: 1.1em;
85 span#email {
87 span#revision {
88 font-family: sans-serif;
91 div#footer {
92 font-family: sans-serif;
93 font-size: small;
94 border-top: 2px solid silver;
95 padding-top: 0.5em;
96 margin-top: 4.0em;
98 div#footer-text {
99 float: left;
100 padding-bottom: 0.5em;
102 div#footer-badges {
103 float: right;
104 padding-bottom: 0.5em;
107 div#preamble,
108 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
109 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
110 div.admonitionblock {
111 margin-right: 10%;
112 margin-top: 1.5em;
113 margin-bottom: 1.5em;
115 div.admonitionblock {
116 margin-top: 2.5em;
117 margin-bottom: 2.5em;
120 div.content { /* Block element content. */
121 padding: 0;
124 /* Block element titles. */
125 div.title, caption.title {
126 font-family: sans-serif;
127 font-weight: bold;
128 text-align: left;
129 margin-top: 1.0em;
130 margin-bottom: 0.5em;
132 div.title + * {
133 margin-top: 0;
136 td div.title:first-child {
137 margin-top: 0.0em;
139 div.content div.title:first-child {
140 margin-top: 0.0em;
142 div.content + div.title {
143 margin-top: 0.0em;
146 div.sidebarblock > div.content {
147 background: #ffffee;
148 border: 1px solid silver;
149 padding: 0.5em;
152 div.listingblock {
153 margin-right: 0%;
155 div.listingblock > div.content {
156 border: 1px solid silver;
157 background: #f4f4f4;
158 padding: 0.5em;
161 div.quoteblock > div.content {
162 padding-left: 2.0em;
165 div.attribution {
166 text-align: right;
168 div.verseblock + div.attribution {
169 text-align: left;
172 div.admonitionblock .icon {
173 vertical-align: top;
174 font-size: 1.1em;
175 font-weight: bold;
176 text-decoration: underline;
177 color: #527bbd;
178 padding-right: 0.5em;
180 div.admonitionblock td.content {
181 padding-left: 0.5em;
182 border-left: 2px solid silver;
185 div.exampleblock > div.content {
186 border-left: 2px solid silver;
187 padding: 0.5em;
190 div.verseblock div.content {
191 white-space: pre;
194 div.imageblock div.content { padding-left: 0; }
195 div.imageblock img { border: 1px solid silver; }
196 span.image img { border-style: none; }
198 dl {
199 margin-top: 0.8em;
200 margin-bottom: 0.8em;
202 dt {
203 margin-top: 0.5em;
204 margin-bottom: 0;
205 font-style: italic;
207 dd > *:first-child {
208 margin-top: 0;
211 ul, ol {
212 list-style-position: outside;
214 div.olist2 ol {
215 list-style-type: lower-alpha;
218 div.tableblock > table {
219 border: 3px solid #527bbd;
221 thead {
222 font-family: sans-serif;
223 font-weight: bold;
225 tfoot {
226 font-weight: bold;
229 div.hlist {
230 margin-top: 0.8em;
231 margin-bottom: 0.8em;
233 div.hlist td {
234 padding-bottom: 5px;
236 td.hlist1 {
237 vertical-align: top;
238 font-style: italic;
239 padding-right: 0.8em;
241 td.hlist2 {
242 vertical-align: top;
245 @media print {
246 div#footer-badges { display: none; }
249 div#toctitle {
250 color: #527bbd;
251 font-family: sans-serif;
252 font-size: 1.1em;
253 font-weight: bold;
254 margin-top: 1.0em;
255 margin-bottom: 0.1em;
258 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
259 margin-top: 0;
260 margin-bottom: 0;
262 div.toclevel2 {
263 margin-left: 2em;
264 font-size: 0.9em;
266 div.toclevel3 {
267 margin-left: 4em;
268 font-size: 0.9em;
270 div.toclevel4 {
271 margin-left: 6em;
272 font-size: 0.9em;
274 include1::./stylesheets/xhtml11-manpage.css[]
275 /* Workarounds for IE6's broken and incomplete CSS2. */
277 div.sidebar-content {
278 background: #ffffee;
279 border: 1px solid silver;
280 padding: 0.5em;
282 div.sidebar-title, div.image-title {
283 font-family: sans-serif;
284 font-weight: bold;
285 margin-top: 0.0em;
286 margin-bottom: 0.5em;
289 div.listingblock div.content {
290 border: 1px solid silver;
291 background: #f4f4f4;
292 padding: 0.5em;
295 div.quoteblock-content {
296 padding-left: 2.0em;
299 div.exampleblock-content {
300 border-left: 2px solid silver;
301 padding-left: 0.5em;
304 /* IE6 sets dynamically generated links as visited. */
305 div#toc a:visited { color: blue; }
306 </style>
307 <title>git-prune(1)</title>
308 </head>
309 <body>
310 <div id="header">
311 <h1>
312 git-prune(1) Manual Page
313 </h1>
314 <h2>NAME</h2>
315 <div class="sectionbody">
316 <p>git-prune -
317 Prune all unreachable objects from the object database
318 </p>
319 </div>
320 </div>
321 <h2>SYNOPSIS</h2>
322 <div class="sectionbody">
323 <div class="para"><p><em>git prune</em> [-n] [-v] [--expire &lt;expire&gt;] [--] [&lt;head&gt;&#8230;]</p></div>
324 </div>
325 <h2 id="_description">DESCRIPTION</h2>
326 <div class="sectionbody">
327 <div class="admonitionblock">
328 <table><tr>
329 <td class="icon">
330 <div class="title">Note</div>
331 </td>
332 <td class="content">In most cases, users should run <em>git gc</em>, which calls
333 <em>git prune</em>. See the section "NOTES", below.</td>
334 </tr></table>
335 </div>
336 <div class="para"><p>This runs <em>git fsck --unreachable</em> using all the refs
337 available in <tt>refs/</tt>, optionally with additional set of
338 objects specified on the command line, and prunes all unpacked
339 objects unreachable from any of these head objects from the object database.
340 In addition, it
341 prunes the unpacked objects that are also found in packs by
342 running <em>git prune-packed</em>.</p></div>
343 <div class="para"><p>Note that unreachable, packed objects will remain. If this is
344 not desired, see <a href="git-repack.html">git-repack(1)</a>.</p></div>
345 </div>
346 <h2 id="_options">OPTIONS</h2>
347 <div class="sectionbody">
348 <div class="vlist"><dl>
349 <dt>
351 </dt>
352 <dt>
353 --dry-run
354 </dt>
355 <dd>
357 Do not remove anything; just report what it would
358 remove.
359 </p>
360 </dd>
361 <dt>
363 </dt>
364 <dt>
365 --verbose
366 </dt>
367 <dd>
369 Report all removed objects.
370 </p>
371 </dd>
372 <dt>
374 </dt>
375 <dd>
377 Do not interpret any more arguments as options.
378 </p>
379 </dd>
380 <dt>
381 --expire &lt;time&gt;
382 </dt>
383 <dd>
385 Only expire loose objects older than &lt;time&gt;.
386 </p>
387 </dd>
388 <dt>
389 &lt;head&gt;&#8230;
390 </dt>
391 <dd>
393 In addition to objects
394 reachable from any of our references, keep objects
395 reachable from listed &lt;head&gt;s.
396 </p>
397 </dd>
398 </dl></div>
399 </div>
400 <h2 id="_example">EXAMPLE</h2>
401 <div class="sectionbody">
402 <div class="para"><p>To prune objects not used by your repository nor another that
403 borrows from your repository via its
404 <tt>.git/objects/info/alternates</tt>:</p></div>
405 <div class="listingblock">
406 <div class="content">
407 <pre><tt>$ git prune $(cd ../another &amp;&amp; $(git rev-parse --all))</tt></pre>
408 </div></div>
409 </div>
410 <h2 id="_notes">Notes</h2>
411 <div class="sectionbody">
412 <div class="para"><p>In most cases, users will not need to call <em>git prune</em> directly, but
413 should instead call <em>git gc</em>, which handles pruning along with
414 many other housekeeping tasks.</p></div>
415 <div class="para"><p>For a description of which objects are considered for pruning, see
416 <em>git fsck</em>'s --unreachable option.</p></div>
417 </div>
418 <h2 id="_see_also">SEE ALSO</h2>
419 <div class="sectionbody">
420 <div class="para"><p><a href="git-fsck.html">git-fsck(1)</a>,
421 <a href="git-gc.html">git-gc(1)</a>,
422 <a href="git-reflog.html">git-reflog(1)</a></p></div>
423 </div>
424 <h2 id="_author">Author</h2>
425 <div class="sectionbody">
426 <div class="para"><p>Written by Linus Torvalds &lt;torvalds@osdl.org&gt;</p></div>
427 </div>
428 <h2 id="_documentation">Documentation</h2>
429 <div class="sectionbody">
430 <div class="para"><p>Documentation by David Greaves, Junio C Hamano and the git-list &lt;git@vger.kernel.org&gt;.</p></div>
431 </div>
432 <h2 id="_git">GIT</h2>
433 <div class="sectionbody">
434 <div class="para"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
435 </div>
436 <div id="footer">
437 <div id="footer-text">
438 Last updated 2010-09-18 23:56:51 UTC
439 </div>
440 </div>
441 </body>
442 </html>