Autogenerated HTML docs for v2.42.0-296-g493f46
[git-htmldocs.git] / git-fsck.html
blobd118d5a319c5bf4a2780dacbbbead1c8412469ce
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
3 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
5 <head>
6 <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
7 <meta name="generator" content="AsciiDoc 10.2.0" />
8 <title>git-fsck(1)</title>
9 <style type="text/css">
10 /* Shared CSS for AsciiDoc xhtml11 and html5 backends */
12 /* Default font. */
13 body {
14 font-family: Georgia,serif;
17 /* Title font. */
18 h1, h2, h3, h4, h5, h6,
19 div.title, caption.title,
20 thead, p.table.header,
21 #toctitle,
22 #author, #revnumber, #revdate, #revremark,
23 #footer {
24 font-family: Arial,Helvetica,sans-serif;
27 body {
28 margin: 1em 5% 1em 5%;
31 a {
32 color: blue;
33 text-decoration: underline;
35 a:visited {
36 color: fuchsia;
39 em {
40 font-style: italic;
41 color: navy;
44 strong {
45 font-weight: bold;
46 color: #083194;
49 h1, h2, h3, h4, h5, h6 {
50 color: #527bbd;
51 margin-top: 1.2em;
52 margin-bottom: 0.5em;
53 line-height: 1.3;
56 h1, h2, h3 {
57 border-bottom: 2px solid silver;
59 h2 {
60 padding-top: 0.5em;
62 h3 {
63 float: left;
65 h3 + * {
66 clear: left;
68 h5 {
69 font-size: 1.0em;
72 div.sectionbody {
73 margin-left: 0;
76 hr {
77 border: 1px solid silver;
80 p {
81 margin-top: 0.5em;
82 margin-bottom: 0.5em;
85 ul, ol, li > p {
86 margin-top: 0;
88 ul > li { color: #aaa; }
89 ul > li > * { color: black; }
91 .monospaced, code, pre {
92 font-family: "Courier New", Courier, monospace;
93 font-size: inherit;
94 color: navy;
95 padding: 0;
96 margin: 0;
98 pre {
99 white-space: pre-wrap;
102 #author {
103 color: #527bbd;
104 font-weight: bold;
105 font-size: 1.1em;
107 #email {
109 #revnumber, #revdate, #revremark {
112 #footer {
113 font-size: small;
114 border-top: 2px solid silver;
115 padding-top: 0.5em;
116 margin-top: 4.0em;
118 #footer-text {
119 float: left;
120 padding-bottom: 0.5em;
122 #footer-badges {
123 float: right;
124 padding-bottom: 0.5em;
127 #preamble {
128 margin-top: 1.5em;
129 margin-bottom: 1.5em;
131 div.imageblock, div.exampleblock, div.verseblock,
132 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
133 div.admonitionblock {
134 margin-top: 1.0em;
135 margin-bottom: 1.5em;
137 div.admonitionblock {
138 margin-top: 2.0em;
139 margin-bottom: 2.0em;
140 margin-right: 10%;
141 color: #606060;
144 div.content { /* Block element content. */
145 padding: 0;
148 /* Block element titles. */
149 div.title, caption.title {
150 color: #527bbd;
151 font-weight: bold;
152 text-align: left;
153 margin-top: 1.0em;
154 margin-bottom: 0.5em;
156 div.title + * {
157 margin-top: 0;
160 td div.title:first-child {
161 margin-top: 0.0em;
163 div.content div.title:first-child {
164 margin-top: 0.0em;
166 div.content + div.title {
167 margin-top: 0.0em;
170 div.sidebarblock > div.content {
171 background: #ffffee;
172 border: 1px solid #dddddd;
173 border-left: 4px solid #f0f0f0;
174 padding: 0.5em;
177 div.listingblock > div.content {
178 border: 1px solid #dddddd;
179 border-left: 5px solid #f0f0f0;
180 background: #f8f8f8;
181 padding: 0.5em;
184 div.quoteblock, div.verseblock {
185 padding-left: 1.0em;
186 margin-left: 1.0em;
187 margin-right: 10%;
188 border-left: 5px solid #f0f0f0;
189 color: #888;
192 div.quoteblock > div.attribution {
193 padding-top: 0.5em;
194 text-align: right;
197 div.verseblock > pre.content {
198 font-family: inherit;
199 font-size: inherit;
201 div.verseblock > div.attribution {
202 padding-top: 0.75em;
203 text-align: left;
205 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
206 div.verseblock + div.attribution {
207 text-align: left;
210 div.admonitionblock .icon {
211 vertical-align: top;
212 font-size: 1.1em;
213 font-weight: bold;
214 text-decoration: underline;
215 color: #527bbd;
216 padding-right: 0.5em;
218 div.admonitionblock td.content {
219 padding-left: 0.5em;
220 border-left: 3px solid #dddddd;
223 div.exampleblock > div.content {
224 border-left: 3px solid #dddddd;
225 padding-left: 0.5em;
228 div.imageblock div.content { padding-left: 0; }
229 span.image img { border-style: none; vertical-align: text-bottom; }
230 a.image:visited { color: white; }
232 dl {
233 margin-top: 0.8em;
234 margin-bottom: 0.8em;
236 dt {
237 margin-top: 0.5em;
238 margin-bottom: 0;
239 font-style: normal;
240 color: navy;
242 dd > *:first-child {
243 margin-top: 0.1em;
246 ul, ol {
247 list-style-position: outside;
249 ol.arabic {
250 list-style-type: decimal;
252 ol.loweralpha {
253 list-style-type: lower-alpha;
255 ol.upperalpha {
256 list-style-type: upper-alpha;
258 ol.lowerroman {
259 list-style-type: lower-roman;
261 ol.upperroman {
262 list-style-type: upper-roman;
265 div.compact ul, div.compact ol,
266 div.compact p, div.compact p,
267 div.compact div, div.compact div {
268 margin-top: 0.1em;
269 margin-bottom: 0.1em;
272 tfoot {
273 font-weight: bold;
275 td > div.verse {
276 white-space: pre;
279 div.hdlist {
280 margin-top: 0.8em;
281 margin-bottom: 0.8em;
283 div.hdlist tr {
284 padding-bottom: 15px;
286 dt.hdlist1.strong, td.hdlist1.strong {
287 font-weight: bold;
289 td.hdlist1 {
290 vertical-align: top;
291 font-style: normal;
292 padding-right: 0.8em;
293 color: navy;
295 td.hdlist2 {
296 vertical-align: top;
298 div.hdlist.compact tr {
299 margin: 0;
300 padding-bottom: 0;
303 .comment {
304 background: yellow;
307 .footnote, .footnoteref {
308 font-size: 0.8em;
311 span.footnote, span.footnoteref {
312 vertical-align: super;
315 #footnotes {
316 margin: 20px 0 20px 0;
317 padding: 7px 0 0 0;
320 #footnotes div.footnote {
321 margin: 0 0 5px 0;
324 #footnotes hr {
325 border: none;
326 border-top: 1px solid silver;
327 height: 1px;
328 text-align: left;
329 margin-left: 0;
330 width: 20%;
331 min-width: 100px;
334 div.colist td {
335 padding-right: 0.5em;
336 padding-bottom: 0.3em;
337 vertical-align: top;
339 div.colist td img {
340 margin-top: 0.3em;
343 @media print {
344 #footer-badges { display: none; }
347 #toc {
348 margin-bottom: 2.5em;
351 #toctitle {
352 color: #527bbd;
353 font-size: 1.1em;
354 font-weight: bold;
355 margin-top: 1.0em;
356 margin-bottom: 0.1em;
359 div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
360 margin-top: 0;
361 margin-bottom: 0;
363 div.toclevel2 {
364 margin-left: 2em;
365 font-size: 0.9em;
367 div.toclevel3 {
368 margin-left: 4em;
369 font-size: 0.9em;
371 div.toclevel4 {
372 margin-left: 6em;
373 font-size: 0.9em;
376 span.aqua { color: aqua; }
377 span.black { color: black; }
378 span.blue { color: blue; }
379 span.fuchsia { color: fuchsia; }
380 span.gray { color: gray; }
381 span.green { color: green; }
382 span.lime { color: lime; }
383 span.maroon { color: maroon; }
384 span.navy { color: navy; }
385 span.olive { color: olive; }
386 span.purple { color: purple; }
387 span.red { color: red; }
388 span.silver { color: silver; }
389 span.teal { color: teal; }
390 span.white { color: white; }
391 span.yellow { color: yellow; }
393 span.aqua-background { background: aqua; }
394 span.black-background { background: black; }
395 span.blue-background { background: blue; }
396 span.fuchsia-background { background: fuchsia; }
397 span.gray-background { background: gray; }
398 span.green-background { background: green; }
399 span.lime-background { background: lime; }
400 span.maroon-background { background: maroon; }
401 span.navy-background { background: navy; }
402 span.olive-background { background: olive; }
403 span.purple-background { background: purple; }
404 span.red-background { background: red; }
405 span.silver-background { background: silver; }
406 span.teal-background { background: teal; }
407 span.white-background { background: white; }
408 span.yellow-background { background: yellow; }
410 span.big { font-size: 2em; }
411 span.small { font-size: 0.6em; }
413 span.underline { text-decoration: underline; }
414 span.overline { text-decoration: overline; }
415 span.line-through { text-decoration: line-through; }
417 div.unbreakable { page-break-inside: avoid; }
421 * xhtml11 specific
423 * */
425 div.tableblock {
426 margin-top: 1.0em;
427 margin-bottom: 1.5em;
429 div.tableblock > table {
430 border: 3px solid #527bbd;
432 thead, p.table.header {
433 font-weight: bold;
434 color: #527bbd;
436 p.table {
437 margin-top: 0;
439 /* Because the table frame attribute is overridden by CSS in most browsers. */
440 div.tableblock > table[frame="void"] {
441 border-style: none;
443 div.tableblock > table[frame="hsides"] {
444 border-left-style: none;
445 border-right-style: none;
447 div.tableblock > table[frame="vsides"] {
448 border-top-style: none;
449 border-bottom-style: none;
454 * html5 specific
456 * */
458 table.tableblock {
459 margin-top: 1.0em;
460 margin-bottom: 1.5em;
462 thead, p.tableblock.header {
463 font-weight: bold;
464 color: #527bbd;
466 p.tableblock {
467 margin-top: 0;
469 table.tableblock {
470 border-width: 3px;
471 border-spacing: 0px;
472 border-style: solid;
473 border-color: #527bbd;
474 border-collapse: collapse;
476 th.tableblock, td.tableblock {
477 border-width: 1px;
478 padding: 4px;
479 border-style: solid;
480 border-color: #527bbd;
483 table.tableblock.frame-topbot {
484 border-left-style: hidden;
485 border-right-style: hidden;
487 table.tableblock.frame-sides {
488 border-top-style: hidden;
489 border-bottom-style: hidden;
491 table.tableblock.frame-none {
492 border-style: hidden;
495 th.tableblock.halign-left, td.tableblock.halign-left {
496 text-align: left;
498 th.tableblock.halign-center, td.tableblock.halign-center {
499 text-align: center;
501 th.tableblock.halign-right, td.tableblock.halign-right {
502 text-align: right;
505 th.tableblock.valign-top, td.tableblock.valign-top {
506 vertical-align: top;
508 th.tableblock.valign-middle, td.tableblock.valign-middle {
509 vertical-align: middle;
511 th.tableblock.valign-bottom, td.tableblock.valign-bottom {
512 vertical-align: bottom;
517 * manpage specific
519 * */
521 body.manpage h1 {
522 padding-top: 0.5em;
523 padding-bottom: 0.5em;
524 border-top: 2px solid silver;
525 border-bottom: 2px solid silver;
527 body.manpage h2 {
528 border-style: none;
530 body.manpage div.sectionbody {
531 margin-left: 3em;
534 @media print {
535 body.manpage div#toc { display: none; }
539 </style>
540 <script type="text/javascript">
541 /*<![CDATA[*/
542 var asciidoc = { // Namespace.
544 /////////////////////////////////////////////////////////////////////
545 // Table Of Contents generator
546 /////////////////////////////////////////////////////////////////////
548 /* Author: Mihai Bazon, September 2002
549 * http://students.infoiasi.ro/~mishoo
551 * Table Of Content generator
552 * Version: 0.4
554 * Feel free to use this script under the terms of the GNU General Public
555 * License, as long as you do not remove or alter this notice.
558 /* modified by Troy D. Hanson, September 2006. License: GPL */
559 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
561 // toclevels = 1..4.
562 toc: function (toclevels) {
564 function getText(el) {
565 var text = "";
566 for (var i = el.firstChild; i != null; i = i.nextSibling) {
567 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
568 text += i.data;
569 else if (i.firstChild != null)
570 text += getText(i);
572 return text;
575 function TocEntry(el, text, toclevel) {
576 this.element = el;
577 this.text = text;
578 this.toclevel = toclevel;
581 function tocEntries(el, toclevels) {
582 var result = new Array;
583 var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
584 // Function that scans the DOM tree for header elements (the DOM2
585 // nodeIterator API would be a better technique but not supported by all
586 // browsers).
587 var iterate = function (el) {
588 for (var i = el.firstChild; i != null; i = i.nextSibling) {
589 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
590 var mo = re.exec(i.tagName);
591 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
592 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
594 iterate(i);
598 iterate(el);
599 return result;
602 var toc = document.getElementById("toc");
603 if (!toc) {
604 return;
607 // Delete existing TOC entries in case we're reloading the TOC.
608 var tocEntriesToRemove = [];
609 var i;
610 for (i = 0; i < toc.childNodes.length; i++) {
611 var entry = toc.childNodes[i];
612 if (entry.nodeName.toLowerCase() == 'div'
613 && entry.getAttribute("class")
614 && entry.getAttribute("class").match(/^toclevel/))
615 tocEntriesToRemove.push(entry);
617 for (i = 0; i < tocEntriesToRemove.length; i++) {
618 toc.removeChild(tocEntriesToRemove[i]);
621 // Rebuild TOC entries.
622 var entries = tocEntries(document.getElementById("content"), toclevels);
623 for (var i = 0; i < entries.length; ++i) {
624 var entry = entries[i];
625 if (entry.element.id == "")
626 entry.element.id = "_toc_" + i;
627 var a = document.createElement("a");
628 a.href = "#" + entry.element.id;
629 a.appendChild(document.createTextNode(entry.text));
630 var div = document.createElement("div");
631 div.appendChild(a);
632 div.className = "toclevel" + entry.toclevel;
633 toc.appendChild(div);
635 if (entries.length == 0)
636 toc.parentNode.removeChild(toc);
640 /////////////////////////////////////////////////////////////////////
641 // Footnotes generator
642 /////////////////////////////////////////////////////////////////////
644 /* Based on footnote generation code from:
645 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
648 footnotes: function () {
649 // Delete existing footnote entries in case we're reloading the footnodes.
650 var i;
651 var noteholder = document.getElementById("footnotes");
652 if (!noteholder) {
653 return;
655 var entriesToRemove = [];
656 for (i = 0; i < noteholder.childNodes.length; i++) {
657 var entry = noteholder.childNodes[i];
658 if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
659 entriesToRemove.push(entry);
661 for (i = 0; i < entriesToRemove.length; i++) {
662 noteholder.removeChild(entriesToRemove[i]);
665 // Rebuild footnote entries.
666 var cont = document.getElementById("content");
667 var spans = cont.getElementsByTagName("span");
668 var refs = {};
669 var n = 0;
670 for (i=0; i<spans.length; i++) {
671 if (spans[i].className == "footnote") {
672 n++;
673 var note = spans[i].getAttribute("data-note");
674 if (!note) {
675 // Use [\s\S] in place of . so multi-line matches work.
676 // Because JavaScript has no s (dotall) regex flag.
677 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
678 spans[i].innerHTML =
679 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
680 "' title='View footnote' class='footnote'>" + n + "</a>]";
681 spans[i].setAttribute("data-note", note);
683 noteholder.innerHTML +=
684 "<div class='footnote' id='_footnote_" + n + "'>" +
685 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
686 n + "</a>. " + note + "</div>";
687 var id =spans[i].getAttribute("id");
688 if (id != null) refs["#"+id] = n;
691 if (n == 0)
692 noteholder.parentNode.removeChild(noteholder);
693 else {
694 // Process footnoterefs.
695 for (i=0; i<spans.length; i++) {
696 if (spans[i].className == "footnoteref") {
697 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
698 href = href.match(/#.*/)[0]; // Because IE return full URL.
699 n = refs[href];
700 spans[i].innerHTML =
701 "[<a href='#_footnote_" + n +
702 "' title='View footnote' class='footnote'>" + n + "</a>]";
708 install: function(toclevels) {
709 var timerId;
711 function reinstall() {
712 asciidoc.footnotes();
713 if (toclevels) {
714 asciidoc.toc(toclevels);
718 function reinstallAndRemoveTimer() {
719 clearInterval(timerId);
720 reinstall();
723 timerId = setInterval(reinstall, 500);
724 if (document.addEventListener)
725 document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
726 else
727 window.onload = reinstallAndRemoveTimer;
731 asciidoc.install();
732 /*]]>*/
733 </script>
734 </head>
735 <body class="manpage">
736 <div id="header">
737 <h1>
738 git-fsck(1) Manual Page
739 </h1>
740 <h2>NAME</h2>
741 <div class="sectionbody">
742 <p>git-fsck -
743 Verifies the connectivity and validity of the objects in the database
744 </p>
745 </div>
746 </div>
747 <div id="content">
748 <div class="sect1">
749 <h2 id="_synopsis">SYNOPSIS</h2>
750 <div class="sectionbody">
751 <div class="verseblock">
752 <pre class="content"><em>git fsck</em> [--tags] [--root] [--unreachable] [--cache] [--no-reflogs]
753 [--[no-]full] [--strict] [--verbose] [--lost-found]
754 [--[no-]dangling] [--[no-]progress] [--connectivity-only]
755 [--[no-]name-objects] [&lt;object&gt;&#8230;]</pre>
756 <div class="attribution">
757 </div></div>
758 </div>
759 </div>
760 <div class="sect1">
761 <h2 id="_description">DESCRIPTION</h2>
762 <div class="sectionbody">
763 <div class="paragraph"><p>Verifies the connectivity and validity of the objects in the database.</p></div>
764 </div>
765 </div>
766 <div class="sect1">
767 <h2 id="_options">OPTIONS</h2>
768 <div class="sectionbody">
769 <div class="dlist"><dl>
770 <dt class="hdlist1">
771 &lt;object&gt;
772 </dt>
773 <dd>
775 An object to treat as the head of an unreachability trace.
776 </p>
777 <div class="paragraph"><p>If no objects are given, <em>git fsck</em> defaults to using the
778 index file, all SHA-1 references in <code>refs</code> namespace, and all reflogs
779 (unless --no-reflogs is given) as heads.</p></div>
780 </dd>
781 <dt class="hdlist1">
782 --unreachable
783 </dt>
784 <dd>
786 Print out objects that exist but that aren&#8217;t reachable from any
787 of the reference nodes.
788 </p>
789 </dd>
790 <dt class="hdlist1">
791 --[no-]dangling
792 </dt>
793 <dd>
795 Print objects that exist but that are never <em>directly</em> used (default).
796 <code>--no-dangling</code> can be used to omit this information from the output.
797 </p>
798 </dd>
799 <dt class="hdlist1">
800 --root
801 </dt>
802 <dd>
804 Report root nodes.
805 </p>
806 </dd>
807 <dt class="hdlist1">
808 --tags
809 </dt>
810 <dd>
812 Report tags.
813 </p>
814 </dd>
815 <dt class="hdlist1">
816 --cache
817 </dt>
818 <dd>
820 Consider any object recorded in the index also as a head node for
821 an unreachability trace.
822 </p>
823 </dd>
824 <dt class="hdlist1">
825 --no-reflogs
826 </dt>
827 <dd>
829 Do not consider commits that are referenced only by an
830 entry in a reflog to be reachable. This option is meant
831 only to search for commits that used to be in a ref, but
832 now aren&#8217;t, but are still in that corresponding reflog.
833 </p>
834 </dd>
835 <dt class="hdlist1">
836 --full
837 </dt>
838 <dd>
840 Check not just objects in GIT_OBJECT_DIRECTORY
841 ($GIT_DIR/objects), but also the ones found in alternate
842 object pools listed in GIT_ALTERNATE_OBJECT_DIRECTORIES
843 or $GIT_DIR/objects/info/alternates,
844 and in packed Git archives found in $GIT_DIR/objects/pack
845 and corresponding pack subdirectories in alternate
846 object pools. This is now default; you can turn it off
847 with --no-full.
848 </p>
849 </dd>
850 <dt class="hdlist1">
851 --connectivity-only
852 </dt>
853 <dd>
855 Check only the connectivity of reachable objects, making sure
856 that any objects referenced by a reachable tag, commit, or tree
857 is present. This speeds up the operation by avoiding reading
858 blobs entirely (though it does still check that referenced blobs
859 exist). This will detect corruption in commits and trees, but
860 not do any semantic checks (e.g., for format errors). Corruption
861 in blob objects will not be detected at all.
862 </p>
863 <div class="paragraph"><p>Unreachable tags, commits, and trees will also be accessed to find the
864 tips of dangling segments of history. Use <code>--no-dangling</code> if you don&#8217;t
865 care about this output and want to speed it up further.</p></div>
866 </dd>
867 <dt class="hdlist1">
868 --strict
869 </dt>
870 <dd>
872 Enable more strict checking, namely to catch a file mode
873 recorded with g+w bit set, which was created by older
874 versions of Git. Existing repositories, including the
875 Linux kernel, Git itself, and sparse repository have old
876 objects that triggers this check, but it is recommended
877 to check new projects with this flag.
878 </p>
879 </dd>
880 <dt class="hdlist1">
881 --verbose
882 </dt>
883 <dd>
885 Be chatty.
886 </p>
887 </dd>
888 <dt class="hdlist1">
889 --lost-found
890 </dt>
891 <dd>
893 Write dangling objects into .git/lost-found/commit/ or
894 .git/lost-found/other/, depending on type. If the object is
895 a blob, the contents are written into the file, rather than
896 its object name.
897 </p>
898 </dd>
899 <dt class="hdlist1">
900 --name-objects
901 </dt>
902 <dd>
904 When displaying names of reachable objects, in addition to the
905 SHA-1 also display a name that describes <strong>how</strong> they are reachable,
906 compatible with <a href="git-rev-parse.html">git-rev-parse(1)</a>, e.g.
907 <code>HEAD@{1234567890}~25^2:src/</code>.
908 </p>
909 </dd>
910 <dt class="hdlist1">
911 --[no-]progress
912 </dt>
913 <dd>
915 Progress status is reported on the standard error stream by
916 default when it is attached to a terminal, unless
917 --no-progress or --verbose is specified. --progress forces
918 progress status even if the standard error stream is not
919 directed to a terminal.
920 </p>
921 </dd>
922 </dl></div>
923 </div>
924 </div>
925 <div class="sect1">
926 <h2 id="_configuration">CONFIGURATION</h2>
927 <div class="sectionbody">
928 <div class="paragraph"><p>Everything below this line in this section is selectively included
929 from the <a href="git-config.html">git-config(1)</a> documentation. The content is the same
930 as what&#8217;s found there:</p></div>
931 <div class="dlist"><dl>
932 <dt class="hdlist1">
933 fsck.&lt;msg-id&gt;
934 </dt>
935 <dd>
937 During fsck git may find issues with legacy data which
938 wouldn&#8217;t be generated by current versions of git, and which
939 wouldn&#8217;t be sent over the wire if <code>transfer.fsckObjects</code> was
940 set. This feature is intended to support working with legacy
941 repositories containing such data.
942 </p>
943 <div class="paragraph"><p>Setting <code>fsck.&lt;msg-id&gt;</code> will be picked up by <a href="git-fsck.html">git-fsck(1)</a>, but
944 to accept pushes of such data set <code>receive.fsck.&lt;msg-id&gt;</code> instead, or
945 to clone or fetch it set <code>fetch.fsck.&lt;msg-id&gt;</code>.</p></div>
946 <div class="paragraph"><p>The rest of the documentation discusses <code>fsck.*</code> for brevity, but the
947 same applies for the corresponding <code>receive.fsck.*</code> and
948 <code>fetch.&lt;msg-id&gt;.*</code>. variables.</p></div>
949 <div class="paragraph"><p>Unlike variables like <code>color.ui</code> and <code>core.editor</code> the
950 <code>receive.fsck.&lt;msg-id&gt;</code> and <code>fetch.fsck.&lt;msg-id&gt;</code> variables will not
951 fall back on the <code>fsck.&lt;msg-id&gt;</code> configuration if they aren&#8217;t set. To
952 uniformly configure the same fsck settings in different circumstances
953 all three of them they must all set to the same values.</p></div>
954 <div class="paragraph"><p>When <code>fsck.&lt;msg-id&gt;</code> is set, errors can be switched to warnings and
955 vice versa by configuring the <code>fsck.&lt;msg-id&gt;</code> setting where the
956 <code>&lt;msg-id&gt;</code> is the fsck message ID and the value is one of <code>error</code>,
957 <code>warn</code> or <code>ignore</code>. For convenience, fsck prefixes the error/warning
958 with the message ID, e.g. "missingEmail: invalid author/committer
959 line - missing email" means that setting <code>fsck.missingEmail = ignore</code>
960 will hide that issue.</p></div>
961 <div class="paragraph"><p>In general, it is better to enumerate existing objects with problems
962 with <code>fsck.skipList</code>, instead of listing the kind of breakages these
963 problematic objects share to be ignored, as doing the latter will
964 allow new instances of the same breakages go unnoticed.</p></div>
965 <div class="paragraph"><p>Setting an unknown <code>fsck.&lt;msg-id&gt;</code> value will cause fsck to die, but
966 doing the same for <code>receive.fsck.&lt;msg-id&gt;</code> and <code>fetch.fsck.&lt;msg-id&gt;</code>
967 will only cause git to warn.</p></div>
968 <div class="paragraph"><p>See <code>Fsck Messages</code> section of <a href="git-fsck.html">git-fsck(1)</a> for supported
969 values of <code>&lt;msg-id&gt;</code>.</p></div>
970 </dd>
971 <dt class="hdlist1">
972 fsck.skipList
973 </dt>
974 <dd>
976 The path to a list of object names (i.e. one unabbreviated SHA-1 per
977 line) that are known to be broken in a non-fatal way and should
978 be ignored. On versions of Git 2.20 and later comments (<em>#</em>), empty
979 lines, and any leading and trailing whitespace is ignored. Everything
980 but a SHA-1 per line will error out on older versions.
981 </p>
982 <div class="paragraph"><p>This feature is useful when an established project should be accepted
983 despite early commits containing errors that can be safely ignored
984 such as invalid committer email addresses. Note: corrupt objects
985 cannot be skipped with this setting.</p></div>
986 <div class="paragraph"><p>Like <code>fsck.&lt;msg-id&gt;</code> this variable has corresponding
987 <code>receive.fsck.skipList</code> and <code>fetch.fsck.skipList</code> variants.</p></div>
988 <div class="paragraph"><p>Unlike variables like <code>color.ui</code> and <code>core.editor</code> the
989 <code>receive.fsck.skipList</code> and <code>fetch.fsck.skipList</code> variables will not
990 fall back on the <code>fsck.skipList</code> configuration if they aren&#8217;t set. To
991 uniformly configure the same fsck settings in different circumstances
992 all three of them they must all set to the same values.</p></div>
993 <div class="paragraph"><p>Older versions of Git (before 2.20) documented that the object names
994 list should be sorted. This was never a requirement, the object names
995 could appear in any order, but when reading the list we tracked whether
996 the list was sorted for the purposes of an internal binary search
997 implementation, which could save itself some work with an already sorted
998 list. Unless you had a humongous list there was no reason to go out of
999 your way to pre-sort the list. After Git version 2.20 a hash implementation
1000 is used instead, so there&#8217;s now no reason to pre-sort the list.</p></div>
1001 </dd>
1002 </dl></div>
1003 </div>
1004 </div>
1005 <div class="sect1">
1006 <h2 id="_discussion">DISCUSSION</h2>
1007 <div class="sectionbody">
1008 <div class="paragraph"><p>git-fsck tests SHA-1 and general object sanity, and it does full tracking
1009 of the resulting reachability and everything else. It prints out any
1010 corruption it finds (missing or bad objects), and if you use the
1011 <code>--unreachable</code> flag it will also print out objects that exist but that
1012 aren&#8217;t reachable from any of the specified head nodes (or the default
1013 set, as mentioned above).</p></div>
1014 <div class="paragraph"><p>Any corrupt objects you will have to find in backups or other archives
1015 (i.e., you can just remove them and do an <em>rsync</em> with some other site in
1016 the hopes that somebody else has the object you have corrupted).</p></div>
1017 <div class="paragraph"><p>If core.commitGraph is true, the commit-graph file will also be inspected
1018 using <em>git commit-graph verify</em>. See <a href="git-commit-graph.html">git-commit-graph(1)</a>.</p></div>
1019 </div>
1020 </div>
1021 <div class="sect1">
1022 <h2 id="_extracted_diagnostics">Extracted Diagnostics</h2>
1023 <div class="sectionbody">
1024 <div class="dlist"><dl>
1025 <dt class="hdlist1">
1026 unreachable &lt;type&gt; &lt;object&gt;
1027 </dt>
1028 <dd>
1030 The &lt;type&gt; object &lt;object&gt;, isn&#8217;t actually referred to directly
1031 or indirectly in any of the trees or commits seen. This can
1032 mean that there&#8217;s another root node that you&#8217;re not specifying
1033 or that the tree is corrupt. If you haven&#8217;t missed a root node
1034 then you might as well delete unreachable nodes since they
1035 can&#8217;t be used.
1036 </p>
1037 </dd>
1038 <dt class="hdlist1">
1039 missing &lt;type&gt; &lt;object&gt;
1040 </dt>
1041 <dd>
1043 The &lt;type&gt; object &lt;object&gt;, is referred to but isn&#8217;t present in
1044 the database.
1045 </p>
1046 </dd>
1047 <dt class="hdlist1">
1048 dangling &lt;type&gt; &lt;object&gt;
1049 </dt>
1050 <dd>
1052 The &lt;type&gt; object &lt;object&gt;, is present in the database but never
1053 <em>directly</em> used. A dangling commit could be a root node.
1054 </p>
1055 </dd>
1056 <dt class="hdlist1">
1057 hash mismatch &lt;object&gt;
1058 </dt>
1059 <dd>
1061 The database has an object whose hash doesn&#8217;t match the
1062 object database value.
1063 This indicates a serious data integrity problem.
1064 </p>
1065 </dd>
1066 </dl></div>
1067 </div>
1068 </div>
1069 <div class="sect1">
1070 <h2 id="_fsck_messages">FSCK MESSAGES</h2>
1071 <div class="sectionbody">
1072 <div class="paragraph"><p>The following lists the types of errors <code>git fsck</code> detects and what
1073 each error means, with their default severity. The severity of the
1074 error, other than those that are marked as "(FATAL)", can be tweaked
1075 by setting the corresponding <code>fsck.&lt;msg-id&gt;</code> configuration variable.</p></div>
1076 <div class="dlist"><dl>
1077 <dt class="hdlist1">
1078 <code>badDate</code>
1079 </dt>
1080 <dd>
1082 (ERROR) Invalid date format in an author/committer line.
1083 </p>
1084 </dd>
1085 <dt class="hdlist1">
1086 <code>badDateOverflow</code>
1087 </dt>
1088 <dd>
1090 (ERROR) Invalid date value in an author/committer line.
1091 </p>
1092 </dd>
1093 <dt class="hdlist1">
1094 <code>badEmail</code>
1095 </dt>
1096 <dd>
1098 (ERROR) Invalid email format in an author/committer line.
1099 </p>
1100 </dd>
1101 <dt class="hdlist1">
1102 <code>badFilemode</code>
1103 </dt>
1104 <dd>
1106 (INFO) A tree contains a bad filemode entry.
1107 </p>
1108 </dd>
1109 <dt class="hdlist1">
1110 <code>badName</code>
1111 </dt>
1112 <dd>
1114 (ERROR) An author/committer name is empty.
1115 </p>
1116 </dd>
1117 <dt class="hdlist1">
1118 <code>badObjectSha1</code>
1119 </dt>
1120 <dd>
1122 (ERROR) An object has a bad sha1.
1123 </p>
1124 </dd>
1125 <dt class="hdlist1">
1126 <code>badParentSha1</code>
1127 </dt>
1128 <dd>
1130 (ERROR) A commit object has a bad parent sha1.
1131 </p>
1132 </dd>
1133 <dt class="hdlist1">
1134 <code>badTagName</code>
1135 </dt>
1136 <dd>
1138 (INFO) A tag has an invalid format.
1139 </p>
1140 </dd>
1141 <dt class="hdlist1">
1142 <code>badTimezone</code>
1143 </dt>
1144 <dd>
1146 (ERROR) Found an invalid time zone in an author/committer line.
1147 </p>
1148 </dd>
1149 <dt class="hdlist1">
1150 <code>badTree</code>
1151 </dt>
1152 <dd>
1154 (ERROR) A tree cannot be parsed.
1155 </p>
1156 </dd>
1157 <dt class="hdlist1">
1158 <code>badTreeSha1</code>
1159 </dt>
1160 <dd>
1162 (ERROR) A tree has an invalid format.
1163 </p>
1164 </dd>
1165 <dt class="hdlist1">
1166 <code>badType</code>
1167 </dt>
1168 <dd>
1170 (ERROR) Found an invalid object type.
1171 </p>
1172 </dd>
1173 <dt class="hdlist1">
1174 <code>duplicateEntries</code>
1175 </dt>
1176 <dd>
1178 (ERROR) A tree contains duplicate file entries.
1179 </p>
1180 </dd>
1181 <dt class="hdlist1">
1182 <code>emptyName</code>
1183 </dt>
1184 <dd>
1186 (WARN) A path contains an empty name.
1187 </p>
1188 </dd>
1189 <dt class="hdlist1">
1190 <code>extraHeaderEntry</code>
1191 </dt>
1192 <dd>
1194 (IGNORE) Extra headers found after <code>tagger</code>.
1195 </p>
1196 </dd>
1197 <dt class="hdlist1">
1198 <code>fullPathname</code>
1199 </dt>
1200 <dd>
1202 (WARN) A path contains the full path starting with "/".
1203 </p>
1204 </dd>
1205 <dt class="hdlist1">
1206 <code>gitattributesBlob</code>
1207 </dt>
1208 <dd>
1210 (ERROR) A non-blob found at <code>.gitattributes</code>.
1211 </p>
1212 </dd>
1213 <dt class="hdlist1">
1214 <code>gitattributesLarge</code>
1215 </dt>
1216 <dd>
1218 (ERROR) The <code>.gitattributes</code> blob is too large.
1219 </p>
1220 </dd>
1221 <dt class="hdlist1">
1222 <code>gitattributesLineLength</code>
1223 </dt>
1224 <dd>
1226 (ERROR) The <code>.gitattributes</code> blob contains too long lines.
1227 </p>
1228 </dd>
1229 <dt class="hdlist1">
1230 <code>gitattributesMissing</code>
1231 </dt>
1232 <dd>
1234 (ERROR) Unable to read <code>.gitattributes</code> blob.
1235 </p>
1236 </dd>
1237 <dt class="hdlist1">
1238 <code>gitattributesSymlink</code>
1239 </dt>
1240 <dd>
1242 (INFO) <code>.gitattributes</code> is a symlink.
1243 </p>
1244 </dd>
1245 <dt class="hdlist1">
1246 <code>gitignoreSymlink</code>
1247 </dt>
1248 <dd>
1250 (INFO) <code>.gitignore</code> is a symlink.
1251 </p>
1252 </dd>
1253 <dt class="hdlist1">
1254 <code>gitmodulesBlob</code>
1255 </dt>
1256 <dd>
1258 (ERROR) A non-blob found at <code>.gitmodules</code>.
1259 </p>
1260 </dd>
1261 <dt class="hdlist1">
1262 <code>gitmodulesLarge</code>
1263 </dt>
1264 <dd>
1266 (ERROR) The <code>.gitmodules</code> file is too large to parse.
1267 </p>
1268 </dd>
1269 <dt class="hdlist1">
1270 <code>gitmodulesMissing</code>
1271 </dt>
1272 <dd>
1274 (ERROR) Unable to read <code>.gitmodules</code> blob.
1275 </p>
1276 </dd>
1277 <dt class="hdlist1">
1278 <code>gitmodulesName</code>
1279 </dt>
1280 <dd>
1282 (ERROR) A submodule name is invalid.
1283 </p>
1284 </dd>
1285 <dt class="hdlist1">
1286 <code>gitmodulesParse</code>
1287 </dt>
1288 <dd>
1290 (INFO) Could not parse <code>.gitmodules</code> blob.
1291 </p>
1292 </dd>
1293 </dl></div>
1294 <div class="paragraph"><p><code>gitmodulesLarge</code>;
1295 (ERROR) <code>.gitmodules</code> blob is too large to parse.</p></div>
1296 <div class="dlist"><dl>
1297 <dt class="hdlist1">
1298 <code>gitmodulesPath</code>
1299 </dt>
1300 <dd>
1302 (ERROR) <code>.gitmodules</code> path is invalid.
1303 </p>
1304 </dd>
1305 <dt class="hdlist1">
1306 <code>gitmodulesSymlink</code>
1307 </dt>
1308 <dd>
1310 (ERROR) <code>.gitmodules</code> is a symlink.
1311 </p>
1312 </dd>
1313 <dt class="hdlist1">
1314 <code>gitmodulesUpdate</code>
1315 </dt>
1316 <dd>
1318 (ERROR) Found an invalid submodule update setting.
1319 </p>
1320 </dd>
1321 <dt class="hdlist1">
1322 <code>gitmodulesUrl</code>
1323 </dt>
1324 <dd>
1326 (ERROR) Found an invalid submodule url.
1327 </p>
1328 </dd>
1329 <dt class="hdlist1">
1330 <code>hasDot</code>
1331 </dt>
1332 <dd>
1334 (WARN) A tree contains an entry named <code>.</code>.
1335 </p>
1336 </dd>
1337 <dt class="hdlist1">
1338 <code>hasDotdot</code>
1339 </dt>
1340 <dd>
1342 (WARN) A tree contains an entry named <code>..</code>.
1343 </p>
1344 </dd>
1345 <dt class="hdlist1">
1346 <code>hasDotgit</code>
1347 </dt>
1348 <dd>
1350 (WARN) A tree contains an entry named <code>.git</code>.
1351 </p>
1352 </dd>
1353 <dt class="hdlist1">
1354 <code>largePathname</code>
1355 </dt>
1356 <dd>
1358 (WARN) A tree contains an entry with a very long path name. If
1359 the value of <code>fsck.largePathname</code> contains a colon, that value
1360 is used as the maximum allowable length (e.g., "warn:10" would
1361 complain about any path component of 11 or more bytes). The
1362 default value is 4096.
1363 </p>
1364 </dd>
1365 <dt class="hdlist1">
1366 <code>mailmapSymlink</code>
1367 </dt>
1368 <dd>
1370 (INFO) <code>.mailmap</code> is a symlink.
1371 </p>
1372 </dd>
1373 <dt class="hdlist1">
1374 <code>missingAuthor</code>
1375 </dt>
1376 <dd>
1378 (ERROR) Author is missing.
1379 </p>
1380 </dd>
1381 <dt class="hdlist1">
1382 <code>missingCommitter</code>
1383 </dt>
1384 <dd>
1386 (ERROR) Committer is missing.
1387 </p>
1388 </dd>
1389 <dt class="hdlist1">
1390 <code>missingEmail</code>
1391 </dt>
1392 <dd>
1394 (ERROR) Email is missing in an author/committer line.
1395 </p>
1396 </dd>
1397 <dt class="hdlist1">
1398 <code>missingNameBeforeEmail</code>
1399 </dt>
1400 <dd>
1402 (ERROR) Missing name before an email in an author/committer line.
1403 </p>
1404 </dd>
1405 <dt class="hdlist1">
1406 <code>missingObject</code>
1407 </dt>
1408 <dd>
1410 (ERROR) Missing <code>object</code> line in tag object.
1411 </p>
1412 </dd>
1413 <dt class="hdlist1">
1414 <code>missingSpaceBeforeDate</code>
1415 </dt>
1416 <dd>
1418 (ERROR) Missing space before date in an author/committer line.
1419 </p>
1420 </dd>
1421 <dt class="hdlist1">
1422 <code>missingSpaceBeforeEmail</code>
1423 </dt>
1424 <dd>
1426 (ERROR) Missing space before the email in author/committer line.
1427 </p>
1428 </dd>
1429 <dt class="hdlist1">
1430 <code>missingTag</code>
1431 </dt>
1432 <dd>
1434 (ERROR) Unexpected end after <code>type</code> line in a tag object.
1435 </p>
1436 </dd>
1437 <dt class="hdlist1">
1438 <code>missingTagEntry</code>
1439 </dt>
1440 <dd>
1442 (ERROR) Missing <code>tag</code> line in a tag object.
1443 </p>
1444 </dd>
1445 <dt class="hdlist1">
1446 <code>missingTaggerEntry</code>
1447 </dt>
1448 <dd>
1450 (INFO) Missing <code>tagger</code> line in a tag object.
1451 </p>
1452 </dd>
1453 <dt class="hdlist1">
1454 <code>missingTree</code>
1455 </dt>
1456 <dd>
1458 (ERROR) Missing <code>tree</code> line in a commit object.
1459 </p>
1460 </dd>
1461 <dt class="hdlist1">
1462 <code>missingType</code>
1463 </dt>
1464 <dd>
1466 (ERROR) Invalid type value on the <code>type</code> line in a tag object.
1467 </p>
1468 </dd>
1469 <dt class="hdlist1">
1470 <code>missingTypeEntry</code>
1471 </dt>
1472 <dd>
1474 (ERROR) Missing <code>type</code> line in a tag object.
1475 </p>
1476 </dd>
1477 <dt class="hdlist1">
1478 <code>multipleAuthors</code>
1479 </dt>
1480 <dd>
1482 (ERROR) Multiple author lines found in a commit.
1483 </p>
1484 </dd>
1485 <dt class="hdlist1">
1486 <code>nulInCommit</code>
1487 </dt>
1488 <dd>
1490 (WARN) Found a NUL byte in the commit object body.
1491 </p>
1492 </dd>
1493 <dt class="hdlist1">
1494 <code>nulInHeader</code>
1495 </dt>
1496 <dd>
1498 (FATAL) NUL byte exists in the object header.
1499 </p>
1500 </dd>
1501 <dt class="hdlist1">
1502 <code>nullSha1</code>
1503 </dt>
1504 <dd>
1506 (WARN) Tree contains entries pointing to a null sha1.
1507 </p>
1508 </dd>
1509 <dt class="hdlist1">
1510 <code>treeNotSorted</code>
1511 </dt>
1512 <dd>
1514 (ERROR) A tree is not properly sorted.
1515 </p>
1516 </dd>
1517 <dt class="hdlist1">
1518 <code>unknownType</code>
1519 </dt>
1520 <dd>
1522 (ERROR) Found an unknown object type.
1523 </p>
1524 </dd>
1525 <dt class="hdlist1">
1526 <code>unterminatedHeader</code>
1527 </dt>
1528 <dd>
1530 (FATAL) Missing end-of-line in the object header.
1531 </p>
1532 </dd>
1533 <dt class="hdlist1">
1534 <code>zeroPaddedDate</code>
1535 </dt>
1536 <dd>
1538 (ERROR) Found a zero padded date in an author/commiter line.
1539 </p>
1540 </dd>
1541 <dt class="hdlist1">
1542 <code>zeroPaddedFilemode</code>
1543 </dt>
1544 <dd>
1546 (WARN) Found a zero padded filemode in a tree.
1547 </p>
1548 </dd>
1549 </dl></div>
1550 </div>
1551 </div>
1552 <div class="sect1">
1553 <h2 id="_environment_variables">Environment Variables</h2>
1554 <div class="sectionbody">
1555 <div class="dlist"><dl>
1556 <dt class="hdlist1">
1557 GIT_OBJECT_DIRECTORY
1558 </dt>
1559 <dd>
1561 used to specify the object database root (usually $GIT_DIR/objects)
1562 </p>
1563 </dd>
1564 <dt class="hdlist1">
1565 GIT_INDEX_FILE
1566 </dt>
1567 <dd>
1569 used to specify the index file of the index
1570 </p>
1571 </dd>
1572 <dt class="hdlist1">
1573 GIT_ALTERNATE_OBJECT_DIRECTORIES
1574 </dt>
1575 <dd>
1577 used to specify additional object database roots (usually unset)
1578 </p>
1579 </dd>
1580 </dl></div>
1581 </div>
1582 </div>
1583 <div class="sect1">
1584 <h2 id="_git">GIT</h2>
1585 <div class="sectionbody">
1586 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
1587 </div>
1588 </div>
1589 </div>
1590 <div id="footnotes"><hr /></div>
1591 <div id="footer">
1592 <div id="footer-text">
1593 Last updated
1594 2022-11-04 21:49:36 PDT
1595 </div>
1596 </div>
1597 </body>
1598 </html>