git-fsck.html

   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.4.5" />
   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 {
  11 /*
  12   border: 1px solid red;
  13 */
  14 }
  15
  16 body {
  17   margin: 1em 5% 1em 5%;
  18 }
  19
  20 a {
  21   color: blue;
  22   text-decoration: underline;
  23 }
  24 a:visited {
  25   color: fuchsia;
  26 }
  27
  28 em {
  29   font-style: italic;
  30   color: navy;
  31 }
  32
  33 strong {
  34   font-weight: bold;
  35   color: #083194;
  36 }
  37
  38 tt {
  39   color: navy;
  40 }
  41
  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;
  48 }
  49
  50 h1, h2, h3 {
  51   border-bottom: 2px solid silver;
  52 }
  53 h2 {
  54   padding-top: 0.5em;
  55 }
  56 h3 {
  57   float: left;
  58 }
  59 h3 + * {
  60   clear: left;
  61 }
  62
  63 div.sectionbody {
  64   font-family: serif;
  65   margin-left: 0;
  66 }
  67
  68 hr {
  69   border: 1px solid silver;
  70 }
  71
  72 p {
  73   margin-top: 0.5em;
  74   margin-bottom: 0.5em;
  75 }
  76
  77 ul, ol, li > p {
  78   margin-top: 0;
  79 }
  80
  81 pre {
  82   padding: 0;
  83   margin: 0;
  84 }
  85
  86 span#author {
  87   color: #527bbd;
  88   font-family: sans-serif;
  89   font-weight: bold;
  90   font-size: 1.1em;
  91 }
  92 span#email {
  93 }
  94 span#revnumber, span#revdate, span#revremark {
  95   font-family: sans-serif;
  96 }
  97
  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;
 104 }
 105 div#footer-text {
 106   float: left;
 107   padding-bottom: 0.5em;
 108 }
 109 div#footer-badges {
 110   float: right;
 111   padding-bottom: 0.5em;
 112 }
 113
 114 div#preamble {
 115   margin-top: 1.5em;
 116   margin-bottom: 1.5em;
 117 }
 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.5em;
 122   margin-bottom: 1.5em;
 123 }
 124 div.admonitionblock {
 125   margin-top: 2.5em;
 126   margin-bottom: 2.5em;
 127 }
 128
 129 div.content { /* Block element content. */
 130   padding: 0;
 131 }
 132
 133 /* Block element titles. */
 134 div.title, caption.title {
 135   color: #527bbd;
 136   font-family: sans-serif;
 137   font-weight: bold;
 138   text-align: left;
 139   margin-top: 1.0em;
 140   margin-bottom: 0.5em;
 141 }
 142 div.title + * {
 143   margin-top: 0;
 144 }
 145
 146 td div.title:first-child {
 147   margin-top: 0.0em;
 148 }
 149 div.content div.title:first-child {
 150   margin-top: 0.0em;
 151 }
 152 div.content + div.title {
 153   margin-top: 0.0em;
 154 }
 155
 156 div.sidebarblock > div.content {
 157   background: #ffffee;
 158   border: 1px solid silver;
 159   padding: 0.5em;
 160 }
 161
 162 div.listingblock > div.content {
 163   border: 1px solid silver;
 164   background: #f4f4f4;
 165   padding: 0.5em;
 166 }
 167
 168 div.quoteblock {
 169   padding-left: 2.0em;
 170   margin-right: 10%;
 171 }
 172 div.quoteblock > div.attribution {
 173   padding-top: 0.5em;
 174   text-align: right;
 175 }
 176
 177 div.verseblock {
 178   padding-left: 2.0em;
 179   margin-right: 10%;
 180 }
 181 div.verseblock > div.content {
 182   white-space: pre;
 183 }
 184 div.verseblock > div.attribution {
 185   padding-top: 0.75em;
 186   text-align: left;
 187 }
 188 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
 189 div.verseblock + div.attribution {
 190   text-align: left;
 191 }
 192
 193 div.admonitionblock .icon {
 194   vertical-align: top;
 195   font-size: 1.1em;
 196   font-weight: bold;
 197   text-decoration: underline;
 198   color: #527bbd;
 199   padding-right: 0.5em;
 200 }
 201 div.admonitionblock td.content {
 202   padding-left: 0.5em;
 203   border-left: 2px solid silver;
 204 }
 205
 206 div.exampleblock > div.content {
 207   border-left: 2px solid silver;
 208   padding: 0.5em;
 209 }
 210
 211 div.imageblock div.content { padding-left: 0; }
 212 span.image img { border-style: none; }
 213 a.image:visited { color: white; }
 214
 215 dl {
 216   margin-top: 0.8em;
 217   margin-bottom: 0.8em;
 218 }
 219 dt {
 220   margin-top: 0.5em;
 221   margin-bottom: 0;
 222   font-style: normal;
 223   color: navy;
 224 }
 225 dd > *:first-child {
 226   margin-top: 0.1em;
 227 }
 228
 229 ul, ol {
 230     list-style-position: outside;
 231 }
 232 ol.arabic {
 233   list-style-type: decimal;
 234 }
 235 ol.loweralpha {
 236   list-style-type: lower-alpha;
 237 }
 238 ol.upperalpha {
 239   list-style-type: upper-alpha;
 240 }
 241 ol.lowerroman {
 242   list-style-type: lower-roman;
 243 }
 244 ol.upperroman {
 245   list-style-type: upper-roman;
 246 }
 247
 248 div.compact ul, div.compact ol,
 249 div.compact p, div.compact p,
 250 div.compact div, div.compact div {
 251   margin-top: 0.1em;
 252   margin-bottom: 0.1em;
 253 }
 254
 255 div.tableblock > table {
 256   border: 3px solid #527bbd;
 257 }
 258 thead {
 259   font-family: sans-serif;
 260   font-weight: bold;
 261 }
 262 tfoot {
 263   font-weight: bold;
 264 }
 265 td > div.verse {
 266   white-space: pre;
 267 }
 268 p.table {
 269   margin-top: 0;
 270 }
 271 /* Because the table frame attribute is overriden by CSS in most browsers. */
 272 div.tableblock > table[frame="void"] {
 273   border-style: none;
 274 }
 275 div.tableblock > table[frame="hsides"] {
 276   border-left-style: none;
 277   border-right-style: none;
 278 }
 279 div.tableblock > table[frame="vsides"] {
 280   border-top-style: none;
 281   border-bottom-style: none;
 282 }
 283
 284
 285 div.hdlist {
 286   margin-top: 0.8em;
 287   margin-bottom: 0.8em;
 288 }
 289 div.hdlist tr {
 290   padding-bottom: 15px;
 291 }
 292 dt.hdlist1.strong, td.hdlist1.strong {
 293   font-weight: bold;
 294 }
 295 td.hdlist1 {
 296   vertical-align: top;
 297   font-style: normal;
 298   padding-right: 0.8em;
 299   color: navy;
 300 }
 301 td.hdlist2 {
 302   vertical-align: top;
 303 }
 304 div.hdlist.compact tr {
 305   margin: 0;
 306   padding-bottom: 0;
 307 }
 308
 309 .comment {
 310   background: yellow;
 311 }
 312
 313 @media print {
 314   div#footer-badges { display: none; }
 315 }
 316
 317 div#toctitle {
 318   color: #527bbd;
 319   font-family: sans-serif;
 320   font-size: 1.1em;
 321   font-weight: bold;
 322   margin-top: 1.0em;
 323   margin-bottom: 0.1em;
 324 }
 325
 326 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
 327   margin-top: 0;
 328   margin-bottom: 0;
 329 }
 330 div.toclevel2 {
 331   margin-left: 2em;
 332   font-size: 0.9em;
 333 }
 334 div.toclevel3 {
 335   margin-left: 4em;
 336   font-size: 0.9em;
 337 }
 338 div.toclevel4 {
 339   margin-left: 6em;
 340   font-size: 0.9em;
 341 }
 342 /* Overrides for manpage documents */
 343 h1 {
 344   padding-top: 0.5em;
 345   padding-bottom: 0.5em;
 346   border-top: 2px solid silver;
 347   border-bottom: 2px solid silver;
 348 }
 349 h2 {
 350   border-style: none;
 351 }
 352 div.sectionbody {
 353   margin-left: 5%;
 354 }
 355
 356 @media print {
 357   div#toc { display: none; }
 358 }
 359
 360 /* Workarounds for IE6's broken and incomplete CSS2. */
 361
 362 div.sidebar-content {
 363   background: #ffffee;
 364   border: 1px solid silver;
 365   padding: 0.5em;
 366 }
 367 div.sidebar-title, div.image-title {
 368   color: #527bbd;
 369   font-family: sans-serif;
 370   font-weight: bold;
 371   margin-top: 0.0em;
 372   margin-bottom: 0.5em;
 373 }
 374
 375 div.listingblock div.content {
 376   border: 1px solid silver;
 377   background: #f4f4f4;
 378   padding: 0.5em;
 379 }
 380
 381 div.quoteblock-attribution {
 382   padding-top: 0.5em;
 383   text-align: right;
 384 }
 385
 386 div.verseblock-content {
 387   white-space: pre;
 388 }
 389 div.verseblock-attribution {
 390   padding-top: 0.75em;
 391   text-align: left;
 392 }
 393
 394 div.exampleblock-content {
 395   border-left: 2px solid silver;
 396   padding-left: 0.5em;
 397 }
 398
 399 /* IE6 sets dynamically generated links as visited. */
 400 div#toc a:visited { color: blue; }
 401 </style>
 402 </head>
 403 <body>
 404 <div id="header">
 405 <h1>
 406 git-fsck(1) Manual Page
 407 </h1>
 408 <h2>NAME</h2>
 409 <div class="sectionbody">
 410 <p>git-fsck -
 411    Verifies the connectivity and validity of the objects in the database
 412 </p>
 413 </div>
 414 </div>
 415 <h2 id="_synopsis">SYNOPSIS</h2>
 416 <div class="sectionbody">
 417 <div class="verseblock">
 418 <div class="verseblock-content"><em>git fsck</em> [--tags] [--root] [--unreachable] [--cache] [--no-reflogs]
 419          [--[no-]full] [--strict] [--verbose] [--lost-found] [&lt;object&gt;*]</div>
 420 <div class="verseblock-attribution">
 421 </div></div>
 422 </div>
 423 <h2 id="_description">DESCRIPTION</h2>
 424 <div class="sectionbody">
 425 <div class="paragraph"><p>Verifies the connectivity and validity of the objects in the database.</p></div>
 426 </div>
 427 <h2 id="_options">OPTIONS</h2>
 428 <div class="sectionbody">
 429 <div class="dlist"><dl>
 430 <dt class="hdlist1">
 431 &lt;object&gt;
 432 </dt>
 433 <dd>
 434 <p>
 435         An object to treat as the head of an unreachability trace.
 436 </p>
 437 <div class="paragraph"><p>If no objects are given, <em>git fsck</em> defaults to using the
 438 index file, all SHA1 references in .git/refs/*, and all reflogs (unless
 439 --no-reflogs is given) as heads.</p></div>
 440 </dd>
 441 <dt class="hdlist1">
 442 --unreachable
 443 </dt>
 444 <dd>
 445 <p>
 446         Print out objects that exist but that aren&#8217;t reachable from any
 447         of the reference nodes.
 448 </p>
 449 </dd>
 450 <dt class="hdlist1">
 451 --root
 452 </dt>
 453 <dd>
 454 <p>
 455         Report root nodes.
 456 </p>
 457 </dd>
 458 <dt class="hdlist1">
 459 --tags
 460 </dt>
 461 <dd>
 462 <p>
 463         Report tags.
 464 </p>
 465 </dd>
 466 <dt class="hdlist1">
 467 --cache
 468 </dt>
 469 <dd>
 470 <p>
 471         Consider any object recorded in the index also as a head node for
 472         an unreachability trace.
 473 </p>
 474 </dd>
 475 <dt class="hdlist1">
 476 --no-reflogs
 477 </dt>
 478 <dd>
 479 <p>
 480         Do not consider commits that are referenced only by an
 481         entry in a reflog to be reachable.  This option is meant
 482         only to search for commits that used to be in a ref, but
 483         now aren&#8217;t, but are still in that corresponding reflog.
 484 </p>
 485 </dd>
 486 <dt class="hdlist1">
 487 --full
 488 </dt>
 489 <dd>
 490 <p>
 491         Check not just objects in GIT_OBJECT_DIRECTORY
 492         ($GIT_DIR/objects), but also the ones found in alternate
 493         object pools listed in GIT_ALTERNATE_OBJECT_DIRECTORIES
 494         or $GIT_DIR/objects/info/alternates,
 495         and in packed git archives found in $GIT_DIR/objects/pack
 496         and corresponding pack subdirectories in alternate
 497         object pools.  This is now default; you can turn it off
 498         with --no-full.
 499 </p>
 500 </dd>
 501 <dt class="hdlist1">
 502 --strict
 503 </dt>
 504 <dd>
 505 <p>
 506         Enable more strict checking, namely to catch a file mode
 507         recorded with g+w bit set, which was created by older
 508         versions of git.  Existing repositories, including the
 509         Linux kernel, git itself, and sparse repository have old
 510         objects that triggers this check, but it is recommended
 511         to check new projects with this flag.
 512 </p>
 513 </dd>
 514 <dt class="hdlist1">
 515 --verbose
 516 </dt>
 517 <dd>
 518 <p>
 519         Be chatty.
 520 </p>
 521 </dd>
 522 <dt class="hdlist1">
 523 --lost-found
 524 </dt>
 525 <dd>
 526 <p>
 527         Write dangling objects into .git/lost-found/commit/ or
 528         .git/lost-found/other/, depending on type.  If the object is
 529         a blob, the contents are written into the file, rather than
 530         its object name.
 531 </p>
 532 </dd>
 533 </dl></div>
 534 <div class="paragraph"><p>It tests SHA1 and general object sanity, and it does full tracking of
 535 the resulting reachability and everything else. It prints out any
 536 corruption it finds (missing or bad objects), and if you use the
 537 <em>--unreachable</em> flag it will also print out objects that exist but
 538 that aren&#8217;t reachable from any of the specified head nodes.</p></div>
 539 <div class="paragraph"><p>So for example</p></div>
 540 <div class="literalblock">
 541 <div class="content">
 542 <pre><tt>git fsck --unreachable HEAD \
 543         $(git for-each-ref --format="%(objectname)" refs/heads)</tt></pre>
 544 </div></div>
 545 <div class="paragraph"><p>will do quite a <em>lot</em> of verification on the tree. There are a few
 546 extra validity tests to be added (make sure that tree objects are
 547 sorted properly etc), but on the whole if <em>git fsck</em> is happy, you
 548 do have a valid tree.</p></div>
 549 <div class="paragraph"><p>Any corrupt objects you will have to find in backups or other archives
 550 (i.e., you can just remove them and do an <em>rsync</em> with some other site in
 551 the hopes that somebody else has the object you have corrupted).</p></div>
 552 <div class="paragraph"><p>Of course, "valid tree" doesn&#8217;t mean that it wasn&#8217;t generated by some
 553 evil person, and the end result might be crap. git is a revision
 554 tracking system, not a quality assurance system ;)</p></div>
 555 </div>
 556 <h2 id="_extracted_diagnostics">Extracted Diagnostics</h2>
 557 <div class="sectionbody">
 558 <div class="dlist"><dl>
 559 <dt class="hdlist1">
 560 expect dangling commits - potential heads - due to lack of head information
 561 </dt>
 562 <dd>
 563 <p>
 564         You haven&#8217;t specified any nodes as heads so it won&#8217;t be
 565         possible to differentiate between un-parented commits and
 566         root nodes.
 567 </p>
 568 </dd>
 569 <dt class="hdlist1">
 570 missing sha1 directory <em>&lt;dir&gt;</em>
 571 </dt>
 572 <dd>
 573 <p>
 574         The directory holding the sha1 objects is missing.
 575 </p>
 576 </dd>
 577 <dt class="hdlist1">
 578 unreachable &lt;type&gt; &lt;object&gt;
 579 </dt>
 580 <dd>
 581 <p>
 582         The &lt;type&gt; object &lt;object&gt;, isn&#8217;t actually referred to directly
 583         or indirectly in any of the trees or commits seen. This can
 584         mean that there&#8217;s another root node that you&#8217;re not specifying
 585         or that the tree is corrupt. If you haven&#8217;t missed a root node
 586         then you might as well delete unreachable nodes since they
 587         can&#8217;t be used.
 588 </p>
 589 </dd>
 590 <dt class="hdlist1">
 591 missing &lt;type&gt; &lt;object&gt;
 592 </dt>
 593 <dd>
 594 <p>
 595         The &lt;type&gt; object &lt;object&gt;, is referred to but isn&#8217;t present in
 596         the database.
 597 </p>
 598 </dd>
 599 <dt class="hdlist1">
 600 dangling &lt;type&gt; &lt;object&gt;
 601 </dt>
 602 <dd>
 603 <p>
 604         The &lt;type&gt; object &lt;object&gt;, is present in the database but never
 605         <em>directly</em> used. A dangling commit could be a root node.
 606 </p>
 607 </dd>
 608 <dt class="hdlist1">
 609 sha1 mismatch &lt;object&gt;
 610 </dt>
 611 <dd>
 612 <p>
 613         The database has an object who&#8217;s sha1 doesn&#8217;t match the
 614         database value.
 615         This indicates a serious data integrity problem.
 616 </p>
 617 </dd>
 618 </dl></div>
 619 </div>
 620 <h2 id="_environment_variables">Environment Variables</h2>
 621 <div class="sectionbody">
 622 <div class="dlist"><dl>
 623 <dt class="hdlist1">
 624 GIT_OBJECT_DIRECTORY
 625 </dt>
 626 <dd>
 627 <p>
 628         used to specify the object database root (usually $GIT_DIR/objects)
 629 </p>
 630 </dd>
 631 <dt class="hdlist1">
 632 GIT_INDEX_FILE
 633 </dt>
 634 <dd>
 635 <p>
 636         used to specify the index file of the index
 637 </p>
 638 </dd>
 639 <dt class="hdlist1">
 640 GIT_ALTERNATE_OBJECT_DIRECTORIES
 641 </dt>
 642 <dd>
 643 <p>
 644         used to specify additional object database roots (usually unset)
 645 </p>
 646 </dd>
 647 </dl></div>
 648 </div>
 649 <h2 id="_git">GIT</h2>
 650 <div class="sectionbody">
 651 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
 652 </div>
 653 <div id="footer">
 654 <div id="footer-text">
 655 Last updated 2011-05-17 06:42:42 UTC
 656 </div>
 657 </div>
 658 </body>
 659 </html>