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 .nf
  26 git\-fsck\-objects [\-\-tags] [\-\-root] [\-\-unreachable] [\-\-cache]
  27                  [\-\-standalone | \-\-full] [\-\-strict] [<object>*]
  28 .fi
  29
  30 .SH "DESCRIPTION"
  31
  32
  33 Verifies the connectivity and validity of the objects in the database\&.
  34
  35 .SH "OPTIONS"
  36
  37 .TP
  38 <object>
  39 An object to treat as the head of an unreachability trace\&.
  40
  41 If no objects are given, git\-fsck\-objects defaults to using the index file and all SHA1 references in \&.git/refs/* as heads\&.
  42
  43 .TP
  44 \-\-unreachable
  45 Print out objects that exist but that aren't readable from any of the reference nodes\&.
  46
  47 .TP
  48 \-\-root
  49 Report root nodes\&.
  50
  51 .TP
  52 \-\-tags
  53 Report tags\&.
  54
  55 .TP
  56 \-\-cache
  57 Consider any object recorded in the index also as a head node for an unreachability trace\&.
  58
  59 .TP
  60 \-\-standalone
  61 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\&.
  62
  63 .TP
  64 \-\-full
  65 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\&.
  66
  67 .TP
  68 \-\-strict
  69 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\&.
  70
  71
  72 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\&.
  73
  74
  75 So for example
  76
  77 .nf
  78 git\-fsck\-objects \-\-unreachable HEAD $(cat \&.git/refs/heads/*)
  79 .fi
  80
  81
  82 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\&.
  83
  84
  85 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)\&.
  86
  87
  88 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 ;)
  89
  90 .SH "EXTRACTED DIAGNOSTICS"
  91
  92 .TP
  93 expect dangling commits \- potential heads \- due to lack of head information
  94 You haven't specified any nodes as heads so it won't be possible to differentiate between un\-parented commits and root nodes\&.
  95
  96 .TP
  97 missing sha1 directory <dir>
  98 The directory holding the sha1 objects is missing\&.
  99
 100 .TP
 101 unreachable <type> <object>
 102 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\&.
 103
 104 .TP
 105 missing <type> <object>
 106 The <type> object <object>, is referred to but isn't present in the database\&.
 107
 108 .TP
 109 dangling <type> <object>
 110 The <type> object <object>, is present in the database but never directly used\&. A dangling commit could be a root node\&.
 111
 112 .TP
 113 warning: git\-fsck\-objects: tree <tree> has full pathnames in it
 114 And it shouldn't...
 115
 116 .TP
 117 sha1 mismatch <object>
 118 The database has an object who's sha1 doesn't match the database value\&. This indicates a serious data integrity problem\&.
 119
 120 .SH "ENVIRONMENT VARIABLES"
 121
 122 .TP
 123 GIT_OBJECT_DIRECTORY
 124 used to specify the object database root (usually $GIT_DIR/objects)
 125
 126 .TP
 127 GIT_INDEX_FILE
 128 used to specify the index file of the index
 129
 130 .TP
 131 GIT_ALTERNATE_OBJECT_DIRECTORIES
 132 used to specify additional object database roots (usually unset)
 133
 134 .SH "AUTHOR"
 135
 136
 137 Written by Linus Torvalds <torvalds@osdl\&.org>
 138
 139 .SH "DOCUMENTATION"
 140
 141
 142 Documentation by David Greaves, Junio C Hamano and the git\-list <git@vger\&.kernel\&.org>\&.
 143
 144 .SH "GIT"
 145
 146
 147 Part of the \fBgit\fR(7) suite
 148