man1/git-fsck-objects.1

   1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
   2 .de Sh \" Subsection
   3 .br
   4 .if t .Sp
   5 .ne 5
   6 .PP
   7 \fB\\$1\fR
   8 .PP
   9 ..
  10 .de Sp \" Vertical space (when we can't use .PP)
  11 .if t .sp .5v
  12 .if n .sp
  13 ..
  14 .de Ip \" List item
  15 .br
  16 .ie \\n(.$>=3 .ne \\$3
  17 .el .ne 3
  18 .IP "\\$1" \\$2
  19 ..
  20 .TH "GIT-FSCK-OBJECTS" 1 "" "" ""
  21 .SH NAME
  22 git-fsck-objects \- Verifies the connectivity and validity of the objects in the database
  23 .SH "SYNOPSIS"
  24
  25
  26 git\-fsck\-objects [\-\-tags] [\-\-root] [\-\-unreachable] [\-\-cache] [\-\-standalone | \-\-full] [\-\-strict] [<object>*]
  27
  28 .SH "DESCRIPTION"
  29
  30
  31 Verifies the connectivity and validity of the objects in the database\&.
  32
  33 .SH "OPTIONS"
  34
  35 .TP
  36 <object>
  37 An object to treat as the head of an unreachability trace\&.
  38
  39 If no objects are given, git\-fsck\-objects defaults to using the index file and all SHA1 references in \&.git/refs/* as heads\&.
  40
  41 .TP
  42 \-\-unreachable
  43 Print out objects that exist but that aren't readable from any of the reference nodes\&.
  44
  45 .TP
  46 \-\-root
  47 Report root nodes\&.
  48
  49 .TP
  50 \-\-tags
  51 Report tags\&.
  52
  53 .TP
  54 \-\-cache
  55 Consider any object recorded in the index also as a head node for an unreachability trace\&.
  56
  57 .TP
  58 \-\-standalone
  59 Limit checks to the contents of GIT_OBJECT_DIRECTORY ($GIT_DIR/objects), making sure that it is consistent and complete without referring to objects found in alternate object pools listed in GIT_ALTERNATE_OBJECT_DIRECTORIES, nor packed git archives found in $GIT_DIR/objects/pack; cannot be used with \-\-full\&.
  60
  61 .TP
  62 \-\-full
  63 Check not just objects in GIT_OBJECT_DIRECTORY ($GIT_DIR/objects), but also the ones found in alternate object pools listed in GIT_ALTERNATE_OBJECT_DIRECTORIES, and in packed git archives found in $GIT_DIR/objects/pack and corresponding pack subdirectories in alternate object pools; cannot be used with \-\-standalone\&.
  64
  65 .TP
  66 \-\-strict
  67 Enable more strict checking, namely to catch a file mode recorded with g+w bit set, which was created by older versions of git\&. Existing repositories, including the Linux kernel, git itself, and sparse repository have old objects that triggers this check, but it is recommended to check new projects with this flag\&.
  68
  69
  70 It tests SHA1 and general object sanity, and it does full tracking of the resulting reachability and everything else\&. It prints out any corruption it finds (missing or bad objects), and if you use the \-\-unreachable flag it will also print out objects that exist but that aren't readable from any of the specified head nodes\&.
  71
  72
  73 So for example
  74
  75 .nf
  76 git\-fsck\-objects \-\-unreachable HEAD $(cat \&.git/refs/heads/*)
  77 .fi
  78
  79
  80 will do quite a _lot_ of verification on the tree\&. There are a few extra validity tests to be added (make sure that tree objects are sorted properly etc), but on the whole if "git\-fsck\-objects" is happy, you do have a valid tree\&.
  81
  82
  83 Any corrupt objects you will have to find in backups or other archives (ie you can just remove them and do an "rsync" with some other site in the hopes that somebody else has the object you have corrupted)\&.
  84
  85
  86 Of course, "valid tree" doesn't mean that it wasn't generated by some evil person, and the end result might be crap\&. git is a revision tracking system, not a quality assurance system ;)
  87
  88 .SH "EXTRACTED DIAGNOSTICS"
  89
  90 .TP
  91 expect dangling commits \- potential heads \- due to lack of head information
  92 You haven't specified any nodes as heads so it won't be possible to differentiate between un\-parented commits and root nodes\&.
  93
  94 .TP
  95 missing sha1 directory <dir>
  96 The directory holding the sha1 objects is missing\&.
  97
  98 .TP
  99 unreachable <type> <object>
 100 The <type> object <object>, isn't actually referred to directly or indirectly in any of the trees or commits seen\&. This can mean that there's another root node that you're not specifying or that the tree is corrupt\&. If you haven't missed a root node then you might as well delete unreachable nodes since they can't be used\&.
 101
 102 .TP
 103 missing <type> <object>
 104 The <type> object <object>, is referred to but isn't present in the database\&.
 105
 106 .TP
 107 dangling <type> <object>
 108 The <type> object <object>, is present in the database but never directly used\&. A dangling commit could be a root node\&.
 109
 110 .TP
 111 warning: git\-fsck\-objects: tree <tree> has full pathnames in it
 112 And it shouldn't...
 113
 114 .TP
 115 sha1 mismatch <object>
 116 The database has an object who's sha1 doesn't match the database value\&. This indicates a serious data integrity problem\&.
 117
 118 .SH "ENVIRONMENT VARIABLES"
 119
 120 .TP
 121 GIT_OBJECT_DIRECTORY
 122 used to specify the object database root (usually $GIT_DIR/objects)
 123
 124 .TP
 125 GIT_INDEX_FILE
 126 used to specify the index file of the index
 127
 128 .TP
 129 GIT_ALTERNATE_OBJECT_DIRECTORIES
 130 used to specify additional object database roots (usually unset)
 131
 132 .SH "AUTHOR"
 133
 134
 135 Written by Linus Torvalds <torvalds@osdl\&.org>
 136
 137 .SH "DOCUMENTATION"
 138
 139
 140 Documentation by David Greaves, Junio C Hamano and the git\-list <git@vger\&.kernel\&.org>\&.
 141
 142 .SH "GIT"
 143
 144
 145 Part of the \fBgit\fR(7) suite
 146