Autogenerated HTML docs for v1.7.7-419-g87009
[git/jnareb-git.git] / git-fsck.html
blob0c7e02dc3bece287f4364b456b8d96b5ef343f94
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.5.2" />
7 <title>git-fsck(1)</title>
8 <style type="text/css">
9 /* Debug borders */
10 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
12 border: 1px solid red;
16 body {
17 margin: 1em 5% 1em 5%;
20 a {
21 color: blue;
22 text-decoration: underline;
24 a:visited {
25 color: fuchsia;
28 em {
29 font-style: italic;
30 color: navy;
33 strong {
34 font-weight: bold;
35 color: #083194;
38 tt {
39 color: navy;
42 h1, h2, h3, h4, h5, h6 {
43 color: #527bbd;
44 font-family: sans-serif;
45 margin-top: 1.2em;
46 margin-bottom: 0.5em;
47 line-height: 1.3;
50 h1, h2, h3 {
51 border-bottom: 2px solid silver;
53 h2 {
54 padding-top: 0.5em;
56 h3 {
57 float: left;
59 h3 + * {
60 clear: left;
63 div.sectionbody {
64 font-family: serif;
65 margin-left: 0;
68 hr {
69 border: 1px solid silver;
72 p {
73 margin-top: 0.5em;
74 margin-bottom: 0.5em;
77 ul, ol, li > p {
78 margin-top: 0;
81 pre {
82 padding: 0;
83 margin: 0;
86 span#author {
87 color: #527bbd;
88 font-family: sans-serif;
89 font-weight: bold;
90 font-size: 1.1em;
92 span#email {
94 span#revnumber, span#revdate, span#revremark {
95 font-family: sans-serif;
98 div#footer {
99 font-family: sans-serif;
100 font-size: small;
101 border-top: 2px solid silver;
102 padding-top: 0.5em;
103 margin-top: 4.0em;
105 div#footer-text {
106 float: left;
107 padding-bottom: 0.5em;
109 div#footer-badges {
110 float: right;
111 padding-bottom: 0.5em;
114 div#preamble {
115 margin-top: 1.5em;
116 margin-bottom: 1.5em;
118 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
119 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
120 div.admonitionblock {
121 margin-top: 1.0em;
122 margin-bottom: 1.5em;
124 div.admonitionblock {
125 margin-top: 2.0em;
126 margin-bottom: 2.0em;
127 margin-right: 10%;
128 color: #606060;
131 div.content { /* Block element content. */
132 padding: 0;
135 /* Block element titles. */
136 div.title, caption.title {
137 color: #527bbd;
138 font-family: sans-serif;
139 font-weight: bold;
140 text-align: left;
141 margin-top: 1.0em;
142 margin-bottom: 0.5em;
144 div.title + * {
145 margin-top: 0;
148 td div.title:first-child {
149 margin-top: 0.0em;
151 div.content div.title:first-child {
152 margin-top: 0.0em;
154 div.content + div.title {
155 margin-top: 0.0em;
158 div.sidebarblock > div.content {
159 background: #ffffee;
160 border: 1px solid silver;
161 padding: 0.5em;
164 div.listingblock > div.content {
165 border: 1px solid silver;
166 background: #f4f4f4;
167 padding: 0.5em;
170 div.quoteblock, div.verseblock {
171 padding-left: 1.0em;
172 margin-left: 1.0em;
173 margin-right: 10%;
174 border-left: 5px solid #dddddd;
175 color: #777777;
178 div.quoteblock > div.attribution {
179 padding-top: 0.5em;
180 text-align: right;
183 div.verseblock > div.content {
184 white-space: pre;
186 div.verseblock > div.attribution {
187 padding-top: 0.75em;
188 text-align: left;
190 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
191 div.verseblock + div.attribution {
192 text-align: left;
195 div.admonitionblock .icon {
196 vertical-align: top;
197 font-size: 1.1em;
198 font-weight: bold;
199 text-decoration: underline;
200 color: #527bbd;
201 padding-right: 0.5em;
203 div.admonitionblock td.content {
204 padding-left: 0.5em;
205 border-left: 3px solid #dddddd;
208 div.exampleblock > div.content {
209 border-left: 3px solid #dddddd;
210 padding-left: 0.5em;
213 div.imageblock div.content { padding-left: 0; }
214 span.image img { border-style: none; }
215 a.image:visited { color: white; }
217 dl {
218 margin-top: 0.8em;
219 margin-bottom: 0.8em;
221 dt {
222 margin-top: 0.5em;
223 margin-bottom: 0;
224 font-style: normal;
225 color: navy;
227 dd > *:first-child {
228 margin-top: 0.1em;
231 ul, ol {
232 list-style-position: outside;
234 ol.arabic {
235 list-style-type: decimal;
237 ol.loweralpha {
238 list-style-type: lower-alpha;
240 ol.upperalpha {
241 list-style-type: upper-alpha;
243 ol.lowerroman {
244 list-style-type: lower-roman;
246 ol.upperroman {
247 list-style-type: upper-roman;
250 div.compact ul, div.compact ol,
251 div.compact p, div.compact p,
252 div.compact div, div.compact div {
253 margin-top: 0.1em;
254 margin-bottom: 0.1em;
257 div.tableblock > table {
258 border: 3px solid #527bbd;
260 thead, p.table.header {
261 font-family: sans-serif;
262 font-weight: bold;
264 tfoot {
265 font-weight: bold;
267 td > div.verse {
268 white-space: pre;
270 p.table {
271 margin-top: 0;
273 /* Because the table frame attribute is overriden by CSS in most browsers. */
274 div.tableblock > table[frame="void"] {
275 border-style: none;
277 div.tableblock > table[frame="hsides"] {
278 border-left-style: none;
279 border-right-style: none;
281 div.tableblock > table[frame="vsides"] {
282 border-top-style: none;
283 border-bottom-style: none;
287 div.hdlist {
288 margin-top: 0.8em;
289 margin-bottom: 0.8em;
291 div.hdlist tr {
292 padding-bottom: 15px;
294 dt.hdlist1.strong, td.hdlist1.strong {
295 font-weight: bold;
297 td.hdlist1 {
298 vertical-align: top;
299 font-style: normal;
300 padding-right: 0.8em;
301 color: navy;
303 td.hdlist2 {
304 vertical-align: top;
306 div.hdlist.compact tr {
307 margin: 0;
308 padding-bottom: 0;
311 .comment {
312 background: yellow;
315 .footnote, .footnoteref {
316 font-size: 0.8em;
319 span.footnote, span.footnoteref {
320 vertical-align: super;
323 #footnotes {
324 margin: 20px 0 20px 0;
325 padding: 7px 0 0 0;
328 #footnotes div.footnote {
329 margin: 0 0 5px 0;
332 #footnotes hr {
333 border: none;
334 border-top: 1px solid silver;
335 height: 1px;
336 text-align: left;
337 margin-left: 0;
338 width: 20%;
339 min-width: 100px;
343 @media print {
344 div#footer-badges { display: none; }
347 div#toc {
348 margin-bottom: 2.5em;
351 div#toctitle {
352 color: #527bbd;
353 font-family: sans-serif;
354 font-size: 1.1em;
355 font-weight: bold;
356 margin-top: 1.0em;
357 margin-bottom: 0.1em;
360 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
361 margin-top: 0;
362 margin-bottom: 0;
364 div.toclevel2 {
365 margin-left: 2em;
366 font-size: 0.9em;
368 div.toclevel3 {
369 margin-left: 4em;
370 font-size: 0.9em;
372 div.toclevel4 {
373 margin-left: 6em;
374 font-size: 0.9em;
376 /* Overrides for manpage documents */
377 h1 {
378 padding-top: 0.5em;
379 padding-bottom: 0.5em;
380 border-top: 2px solid silver;
381 border-bottom: 2px solid silver;
383 h2 {
384 border-style: none;
386 div.sectionbody {
387 margin-left: 5%;
390 @media print {
391 div#toc { display: none; }
394 /* Workarounds for IE6's broken and incomplete CSS2. */
396 div.sidebar-content {
397 background: #ffffee;
398 border: 1px solid silver;
399 padding: 0.5em;
401 div.sidebar-title, div.image-title {
402 color: #527bbd;
403 font-family: sans-serif;
404 font-weight: bold;
405 margin-top: 0.0em;
406 margin-bottom: 0.5em;
409 div.listingblock div.content {
410 border: 1px solid silver;
411 background: #f4f4f4;
412 padding: 0.5em;
415 div.quoteblock-attribution {
416 padding-top: 0.5em;
417 text-align: right;
420 div.verseblock-content {
421 white-space: pre;
423 div.verseblock-attribution {
424 padding-top: 0.75em;
425 text-align: left;
428 div.exampleblock-content {
429 border-left: 3px solid #dddddd;
430 padding-left: 0.5em;
433 /* IE6 sets dynamically generated links as visited. */
434 div#toc a:visited { color: blue; }
435 </style>
436 <script type="text/javascript">
437 /*<![CDATA[*/
438 window.onload = function(){asciidoc.footnotes();}
439 var asciidoc = { // Namespace.
441 /////////////////////////////////////////////////////////////////////
442 // Table Of Contents generator
443 /////////////////////////////////////////////////////////////////////
445 /* Author: Mihai Bazon, September 2002
446 * http://students.infoiasi.ro/~mishoo
448 * Table Of Content generator
449 * Version: 0.4
451 * Feel free to use this script under the terms of the GNU General Public
452 * License, as long as you do not remove or alter this notice.
455 /* modified by Troy D. Hanson, September 2006. License: GPL */
456 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
458 // toclevels = 1..4.
459 toc: function (toclevels) {
461 function getText(el) {
462 var text = "";
463 for (var i = el.firstChild; i != null; i = i.nextSibling) {
464 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
465 text += i.data;
466 else if (i.firstChild != null)
467 text += getText(i);
469 return text;
472 function TocEntry(el, text, toclevel) {
473 this.element = el;
474 this.text = text;
475 this.toclevel = toclevel;
478 function tocEntries(el, toclevels) {
479 var result = new Array;
480 var re = new RegExp('[hH]([2-'+(toclevels+1)+'])');
481 // Function that scans the DOM tree for header elements (the DOM2
482 // nodeIterator API would be a better technique but not supported by all
483 // browsers).
484 var iterate = function (el) {
485 for (var i = el.firstChild; i != null; i = i.nextSibling) {
486 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
487 var mo = re.exec(i.tagName);
488 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
489 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
491 iterate(i);
495 iterate(el);
496 return result;
499 var toc = document.getElementById("toc");
500 var entries = tocEntries(document.getElementById("content"), toclevels);
501 for (var i = 0; i < entries.length; ++i) {
502 var entry = entries[i];
503 if (entry.element.id == "")
504 entry.element.id = "_toc_" + i;
505 var a = document.createElement("a");
506 a.href = "#" + entry.element.id;
507 a.appendChild(document.createTextNode(entry.text));
508 var div = document.createElement("div");
509 div.appendChild(a);
510 div.className = "toclevel" + entry.toclevel;
511 toc.appendChild(div);
513 if (entries.length == 0)
514 toc.parentNode.removeChild(toc);
518 /////////////////////////////////////////////////////////////////////
519 // Footnotes generator
520 /////////////////////////////////////////////////////////////////////
522 /* Based on footnote generation code from:
523 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
526 footnotes: function () {
527 var cont = document.getElementById("content");
528 var noteholder = document.getElementById("footnotes");
529 var spans = cont.getElementsByTagName("span");
530 var refs = {};
531 var n = 0;
532 for (i=0; i<spans.length; i++) {
533 if (spans[i].className == "footnote") {
534 n++;
535 // Use [\s\S] in place of . so multi-line matches work.
536 // Because JavaScript has no s (dotall) regex flag.
537 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
538 noteholder.innerHTML +=
539 "<div class='footnote' id='_footnote_" + n + "'>" +
540 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
541 n + "</a>. " + note + "</div>";
542 spans[i].innerHTML =
543 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
544 "' title='View footnote' class='footnote'>" + n + "</a>]";
545 var id =spans[i].getAttribute("id");
546 if (id != null) refs["#"+id] = n;
549 if (n == 0)
550 noteholder.parentNode.removeChild(noteholder);
551 else {
552 // Process footnoterefs.
553 for (i=0; i<spans.length; i++) {
554 if (spans[i].className == "footnoteref") {
555 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
556 href = href.match(/#.*/)[0]; // Because IE return full URL.
557 n = refs[href];
558 spans[i].innerHTML =
559 "[<a href='#_footnote_" + n +
560 "' title='View footnote' class='footnote'>" + n + "</a>]";
567 /*]]>*/
568 </script>
569 </head>
570 <body>
571 <div id="header">
572 <h1>
573 git-fsck(1) Manual Page
574 </h1>
575 <h2>NAME</h2>
576 <div class="sectionbody">
577 <p>git-fsck -
578 Verifies the connectivity and validity of the objects in the database
579 </p>
580 </div>
581 </div>
582 <div id="content">
583 <h2 id="_synopsis">SYNOPSIS</h2>
584 <div class="sectionbody">
585 <div class="verseblock">
586 <div class="verseblock-content"><em>git fsck</em> [--tags] [--root] [--unreachable] [--cache] [--no-reflogs]
587 [--[no-]full] [--strict] [--verbose] [--lost-found] [&lt;object&gt;*]</div>
588 <div class="verseblock-attribution">
589 </div></div>
590 </div>
591 <h2 id="_description">DESCRIPTION</h2>
592 <div class="sectionbody">
593 <div class="paragraph"><p>Verifies the connectivity and validity of the objects in the database.</p></div>
594 </div>
595 <h2 id="_options">OPTIONS</h2>
596 <div class="sectionbody">
597 <div class="dlist"><dl>
598 <dt class="hdlist1">
599 &lt;object&gt;
600 </dt>
601 <dd>
603 An object to treat as the head of an unreachability trace.
604 </p>
605 <div class="paragraph"><p>If no objects are given, <em>git fsck</em> defaults to using the
606 index file, all SHA1 references in .git/refs/*, and all reflogs (unless
607 --no-reflogs is given) as heads.</p></div>
608 </dd>
609 <dt class="hdlist1">
610 --unreachable
611 </dt>
612 <dd>
614 Print out objects that exist but that aren&#8217;t reachable from any
615 of the reference nodes.
616 </p>
617 </dd>
618 <dt class="hdlist1">
619 --root
620 </dt>
621 <dd>
623 Report root nodes.
624 </p>
625 </dd>
626 <dt class="hdlist1">
627 --tags
628 </dt>
629 <dd>
631 Report tags.
632 </p>
633 </dd>
634 <dt class="hdlist1">
635 --cache
636 </dt>
637 <dd>
639 Consider any object recorded in the index also as a head node for
640 an unreachability trace.
641 </p>
642 </dd>
643 <dt class="hdlist1">
644 --no-reflogs
645 </dt>
646 <dd>
648 Do not consider commits that are referenced only by an
649 entry in a reflog to be reachable. This option is meant
650 only to search for commits that used to be in a ref, but
651 now aren&#8217;t, but are still in that corresponding reflog.
652 </p>
653 </dd>
654 <dt class="hdlist1">
655 --full
656 </dt>
657 <dd>
659 Check not just objects in GIT_OBJECT_DIRECTORY
660 ($GIT_DIR/objects), but also the ones found in alternate
661 object pools listed in GIT_ALTERNATE_OBJECT_DIRECTORIES
662 or $GIT_DIR/objects/info/alternates,
663 and in packed git archives found in $GIT_DIR/objects/pack
664 and corresponding pack subdirectories in alternate
665 object pools. This is now default; you can turn it off
666 with --no-full.
667 </p>
668 </dd>
669 <dt class="hdlist1">
670 --strict
671 </dt>
672 <dd>
674 Enable more strict checking, namely to catch a file mode
675 recorded with g+w bit set, which was created by older
676 versions of git. Existing repositories, including the
677 Linux kernel, git itself, and sparse repository have old
678 objects that triggers this check, but it is recommended
679 to check new projects with this flag.
680 </p>
681 </dd>
682 <dt class="hdlist1">
683 --verbose
684 </dt>
685 <dd>
687 Be chatty.
688 </p>
689 </dd>
690 <dt class="hdlist1">
691 --lost-found
692 </dt>
693 <dd>
695 Write dangling objects into .git/lost-found/commit/ or
696 .git/lost-found/other/, depending on type. If the object is
697 a blob, the contents are written into the file, rather than
698 its object name.
699 </p>
700 </dd>
701 </dl></div>
702 <div class="paragraph"><p>It tests SHA1 and general object sanity, and it does full tracking of
703 the resulting reachability and everything else. It prints out any
704 corruption it finds (missing or bad objects), and if you use the
705 <em>--unreachable</em> flag it will also print out objects that exist but
706 that aren&#8217;t reachable from any of the specified head nodes.</p></div>
707 <div class="paragraph"><p>So for example</p></div>
708 <div class="literalblock">
709 <div class="content">
710 <pre><tt>git fsck --unreachable HEAD \
711 $(git for-each-ref --format="%(objectname)" refs/heads)</tt></pre>
712 </div></div>
713 <div class="paragraph"><p>will do quite a <em>lot</em> of verification on the tree. There are a few
714 extra validity tests to be added (make sure that tree objects are
715 sorted properly etc), but on the whole if <em>git fsck</em> is happy, you
716 do have a valid tree.</p></div>
717 <div class="paragraph"><p>Any corrupt objects you will have to find in backups or other archives
718 (i.e., you can just remove them and do an <em>rsync</em> with some other site in
719 the hopes that somebody else has the object you have corrupted).</p></div>
720 <div class="paragraph"><p>Of course, "valid tree" doesn&#8217;t mean that it wasn&#8217;t generated by some
721 evil person, and the end result might be crap. git is a revision
722 tracking system, not a quality assurance system ;)</p></div>
723 </div>
724 <h2 id="_extracted_diagnostics">Extracted Diagnostics</h2>
725 <div class="sectionbody">
726 <div class="dlist"><dl>
727 <dt class="hdlist1">
728 expect dangling commits - potential heads - due to lack of head information
729 </dt>
730 <dd>
732 You haven&#8217;t specified any nodes as heads so it won&#8217;t be
733 possible to differentiate between un-parented commits and
734 root nodes.
735 </p>
736 </dd>
737 <dt class="hdlist1">
738 missing sha1 directory <em>&lt;dir&gt;</em>
739 </dt>
740 <dd>
742 The directory holding the sha1 objects is missing.
743 </p>
744 </dd>
745 <dt class="hdlist1">
746 unreachable &lt;type&gt; &lt;object&gt;
747 </dt>
748 <dd>
750 The &lt;type&gt; object &lt;object&gt;, isn&#8217;t actually referred to directly
751 or indirectly in any of the trees or commits seen. This can
752 mean that there&#8217;s another root node that you&#8217;re not specifying
753 or that the tree is corrupt. If you haven&#8217;t missed a root node
754 then you might as well delete unreachable nodes since they
755 can&#8217;t be used.
756 </p>
757 </dd>
758 <dt class="hdlist1">
759 missing &lt;type&gt; &lt;object&gt;
760 </dt>
761 <dd>
763 The &lt;type&gt; object &lt;object&gt;, is referred to but isn&#8217;t present in
764 the database.
765 </p>
766 </dd>
767 <dt class="hdlist1">
768 dangling &lt;type&gt; &lt;object&gt;
769 </dt>
770 <dd>
772 The &lt;type&gt; object &lt;object&gt;, is present in the database but never
773 <em>directly</em> used. A dangling commit could be a root node.
774 </p>
775 </dd>
776 <dt class="hdlist1">
777 sha1 mismatch &lt;object&gt;
778 </dt>
779 <dd>
781 The database has an object who&#8217;s sha1 doesn&#8217;t match the
782 database value.
783 This indicates a serious data integrity problem.
784 </p>
785 </dd>
786 </dl></div>
787 </div>
788 <h2 id="_environment_variables">Environment Variables</h2>
789 <div class="sectionbody">
790 <div class="dlist"><dl>
791 <dt class="hdlist1">
792 GIT_OBJECT_DIRECTORY
793 </dt>
794 <dd>
796 used to specify the object database root (usually $GIT_DIR/objects)
797 </p>
798 </dd>
799 <dt class="hdlist1">
800 GIT_INDEX_FILE
801 </dt>
802 <dd>
804 used to specify the index file of the index
805 </p>
806 </dd>
807 <dt class="hdlist1">
808 GIT_ALTERNATE_OBJECT_DIRECTORIES
809 </dt>
810 <dd>
812 used to specify additional object database roots (usually unset)
813 </p>
814 </dd>
815 </dl></div>
816 </div>
817 <h2 id="_git">GIT</h2>
818 <div class="sectionbody">
819 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
820 </div>
821 </div>
822 <div id="footnotes"><hr /></div>
823 <div id="footer">
824 <div id="footer-text">
825 Last updated 2011-09-21 23:01:14 PDT
826 </div>
827 </div>
828 </body>
829 </html>