man1/git-fsck.1

   1 '\" t
   2 .\"     Title: git-fsck
   3 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
   4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
   5 .\"      Date: 05/11/2022
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.36.1.74.g277cf0bc36
   8 .\"  Language: English
   9 .\"
  10 .TH "GIT\-FSCK" "1" "05/11/2022" "Git 2\&.36\&.1\&.74\&.g277cf0b" "Git Manual"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 git-fsck \- Verifies the connectivity and validity of the objects in the database
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 \fIgit fsck\fR [\-\-tags] [\-\-root] [\-\-unreachable] [\-\-cache] [\-\-no\-reflogs]
  36          [\-\-[no\-]full] [\-\-strict] [\-\-verbose] [\-\-lost\-found]
  37          [\-\-[no\-]dangling] [\-\-[no\-]progress] [\-\-connectivity\-only]
  38          [\-\-[no\-]name\-objects] [<object>\&...]
  39 .fi
  40 .sp
  41 .SH "DESCRIPTION"
  42 .sp
  43 Verifies the connectivity and validity of the objects in the database\&.
  44 .SH "OPTIONS"
  45 .PP
  46 <object>
  47 .RS 4
  48 An object to treat as the head of an unreachability trace\&.
  49 .sp
  50 If no objects are given,
  51 \fIgit fsck\fR
  52 defaults to using the index file, all SHA\-1 references in
  53 \fBrefs\fR
  54 namespace, and all reflogs (unless \-\-no\-reflogs is given) as heads\&.
  55 .RE
  56 .PP
  57 \-\-unreachable
  58 .RS 4
  59 Print out objects that exist but that aren\(cqt reachable from any of the reference nodes\&.
  60 .RE
  61 .PP
  62 \-\-[no\-]dangling
  63 .RS 4
  64 Print objects that exist but that are never
  65 \fIdirectly\fR
  66 used (default)\&.
  67 \fB\-\-no\-dangling\fR
  68 can be used to omit this information from the output\&.
  69 .RE
  70 .PP
  71 \-\-root
  72 .RS 4
  73 Report root nodes\&.
  74 .RE
  75 .PP
  76 \-\-tags
  77 .RS 4
  78 Report tags\&.
  79 .RE
  80 .PP
  81 \-\-cache
  82 .RS 4
  83 Consider any object recorded in the index also as a head node for an unreachability trace\&.
  84 .RE
  85 .PP
  86 \-\-no\-reflogs
  87 .RS 4
  88 Do not consider commits that are referenced only by an entry in a reflog to be reachable\&. This option is meant only to search for commits that used to be in a ref, but now aren\(cqt, but are still in that corresponding reflog\&.
  89 .RE
  90 .PP
  91 \-\-full
  92 .RS 4
  93 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 or $GIT_DIR/objects/info/alternates, and in packed Git archives found in $GIT_DIR/objects/pack and corresponding pack subdirectories in alternate object pools\&. This is now default; you can turn it off with \-\-no\-full\&.
  94 .RE
  95 .PP
  96 \-\-connectivity\-only
  97 .RS 4
  98 Check only the connectivity of reachable objects, making sure that any objects referenced by a reachable tag, commit, or tree is present\&. This speeds up the operation by avoiding reading blobs entirely (though it does still check that referenced blobs exist)\&. This will detect corruption in commits and trees, but not do any semantic checks (e\&.g\&., for format errors)\&. Corruption in blob objects will not be detected at all\&.
  99 .sp
 100 Unreachable tags, commits, and trees will also be accessed to find the tips of dangling segments of history\&. Use
 101 \fB\-\-no\-dangling\fR
 102 if you don\(cqt care about this output and want to speed it up further\&.
 103 .RE
 104 .PP
 105 \-\-strict
 106 .RS 4
 107 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\&.
 108 .RE
 109 .PP
 110 \-\-verbose
 111 .RS 4
 112 Be chatty\&.
 113 .RE
 114 .PP
 115 \-\-lost\-found
 116 .RS 4
 117 Write dangling objects into \&.git/lost\-found/commit/ or \&.git/lost\-found/other/, depending on type\&. If the object is a blob, the contents are written into the file, rather than its object name\&.
 118 .RE
 119 .PP
 120 \-\-name\-objects
 121 .RS 4
 122 When displaying names of reachable objects, in addition to the SHA\-1 also display a name that describes
 123 \fBhow\fR
 124 they are reachable, compatible with
 125 \fBgit-rev-parse\fR(1), e\&.g\&.
 126 \fBHEAD@{1234567890}~25^2:src/\fR\&.
 127 .RE
 128 .PP
 129 \-\-[no\-]progress
 130 .RS 4
 131 Progress status is reported on the standard error stream by default when it is attached to a terminal, unless \-\-no\-progress or \-\-verbose is specified\&. \-\-progress forces progress status even if the standard error stream is not directed to a terminal\&.
 132 .RE
 133 .SH "CONFIGURATION"
 134 .PP
 135 fsck\&.<msg\-id>
 136 .RS 4
 137 During fsck git may find issues with legacy data which wouldn\(cqt be generated by current versions of git, and which wouldn\(cqt be sent over the wire if
 138 \fBtransfer\&.fsckObjects\fR
 139 was set\&. This feature is intended to support working with legacy repositories containing such data\&.
 140 .sp
 141 Setting
 142 \fBfsck\&.<msg\-id>\fR
 143 will be picked up by
 144 \fBgit-fsck\fR(1), but to accept pushes of such data set
 145 \fBreceive\&.fsck\&.<msg\-id>\fR
 146 instead, or to clone or fetch it set
 147 \fBfetch\&.fsck\&.<msg\-id>\fR\&.
 148 .sp
 149 The rest of the documentation discusses
 150 \fBfsck\&.*\fR
 151 for brevity, but the same applies for the corresponding
 152 \fBreceive\&.fsck\&.*\fR
 153 and
 154 \fBfetch\&.<msg\-id>\&.*\fR\&. variables\&.
 155 .sp
 156 Unlike variables like
 157 \fBcolor\&.ui\fR
 158 and
 159 \fBcore\&.editor\fR
 160 the
 161 \fBreceive\&.fsck\&.<msg\-id>\fR
 162 and
 163 \fBfetch\&.fsck\&.<msg\-id>\fR
 164 variables will not fall back on the
 165 \fBfsck\&.<msg\-id>\fR
 166 configuration if they aren\(cqt set\&. To uniformly configure the same fsck settings in different circumstances all three of them they must all set to the same values\&.
 167 .sp
 168 When
 169 \fBfsck\&.<msg\-id>\fR
 170 is set, errors can be switched to warnings and vice versa by configuring the
 171 \fBfsck\&.<msg\-id>\fR
 172 setting where the
 173 \fB<msg\-id>\fR
 174 is the fsck message ID and the value is one of
 175 \fBerror\fR,
 176 \fBwarn\fR
 177 or
 178 \fBignore\fR\&. For convenience, fsck prefixes the error/warning with the message ID, e\&.g\&. "missingEmail: invalid author/committer line \- missing email" means that setting
 179 \fBfsck\&.missingEmail = ignore\fR
 180 will hide that issue\&.
 181 .sp
 182 In general, it is better to enumerate existing objects with problems with
 183 \fBfsck\&.skipList\fR, instead of listing the kind of breakages these problematic objects share to be ignored, as doing the latter will allow new instances of the same breakages go unnoticed\&.
 184 .sp
 185 Setting an unknown
 186 \fBfsck\&.<msg\-id>\fR
 187 value will cause fsck to die, but doing the same for
 188 \fBreceive\&.fsck\&.<msg\-id>\fR
 189 and
 190 \fBfetch\&.fsck\&.<msg\-id>\fR
 191 will only cause git to warn\&.
 192 .RE
 193 .PP
 194 fsck\&.skipList
 195 .RS 4
 196 The path to a list of object names (i\&.e\&. one unabbreviated SHA\-1 per line) that are known to be broken in a non\-fatal way and should be ignored\&. On versions of Git 2\&.20 and later comments (\fI#\fR), empty lines, and any leading and trailing whitespace is ignored\&. Everything but a SHA\-1 per line will error out on older versions\&.
 197 .sp
 198 This feature is useful when an established project should be accepted despite early commits containing errors that can be safely ignored such as invalid committer email addresses\&. Note: corrupt objects cannot be skipped with this setting\&.
 199 .sp
 200 Like
 201 \fBfsck\&.<msg\-id>\fR
 202 this variable has corresponding
 203 \fBreceive\&.fsck\&.skipList\fR
 204 and
 205 \fBfetch\&.fsck\&.skipList\fR
 206 variants\&.
 207 .sp
 208 Unlike variables like
 209 \fBcolor\&.ui\fR
 210 and
 211 \fBcore\&.editor\fR
 212 the
 213 \fBreceive\&.fsck\&.skipList\fR
 214 and
 215 \fBfetch\&.fsck\&.skipList\fR
 216 variables will not fall back on the
 217 \fBfsck\&.skipList\fR
 218 configuration if they aren\(cqt set\&. To uniformly configure the same fsck settings in different circumstances all three of them they must all set to the same values\&.
 219 .sp
 220 Older versions of Git (before 2\&.20) documented that the object names list should be sorted\&. This was never a requirement, the object names could appear in any order, but when reading the list we tracked whether the list was sorted for the purposes of an internal binary search implementation, which could save itself some work with an already sorted list\&. Unless you had a humongous list there was no reason to go out of your way to pre\-sort the list\&. After Git version 2\&.20 a hash implementation is used instead, so there\(cqs now no reason to pre\-sort the list\&.
 221 .RE
 222 .SH "DISCUSSION"
 223 .sp
 224 git\-fsck tests SHA\-1 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 \fB\-\-unreachable\fR flag it will also print out objects that exist but that aren\(cqt reachable from any of the specified head nodes (or the default set, as mentioned above)\&.
 225 .sp
 226 Any corrupt objects you will have to find in backups or other archives (i\&.e\&., you can just remove them and do an \fIrsync\fR with some other site in the hopes that somebody else has the object you have corrupted)\&.
 227 .sp
 228 If core\&.commitGraph is true, the commit\-graph file will also be inspected using \fIgit commit\-graph verify\fR\&. See \fBgit-commit-graph\fR(1)\&.
 229 .SH "EXTRACTED DIAGNOSTICS"
 230 .PP
 231 unreachable <type> <object>
 232 .RS 4
 233 The <type> object <object>, isn\(cqt actually referred to directly or indirectly in any of the trees or commits seen\&. This can mean that there\(cqs another root node that you\(cqre not specifying or that the tree is corrupt\&. If you haven\(cqt missed a root node then you might as well delete unreachable nodes since they can\(cqt be used\&.
 234 .RE
 235 .PP
 236 missing <type> <object>
 237 .RS 4
 238 The <type> object <object>, is referred to but isn\(cqt present in the database\&.
 239 .RE
 240 .PP
 241 dangling <type> <object>
 242 .RS 4
 243 The <type> object <object>, is present in the database but never
 244 \fIdirectly\fR
 245 used\&. A dangling commit could be a root node\&.
 246 .RE
 247 .PP
 248 hash mismatch <object>
 249 .RS 4
 250 The database has an object whose hash doesn\(cqt match the object database value\&. This indicates a serious data integrity problem\&.
 251 .RE
 252 .SH "ENVIRONMENT VARIABLES"
 253 .PP
 254 GIT_OBJECT_DIRECTORY
 255 .RS 4
 256 used to specify the object database root (usually $GIT_DIR/objects)
 257 .RE
 258 .PP
 259 GIT_INDEX_FILE
 260 .RS 4
 261 used to specify the index file of the index
 262 .RE
 263 .PP
 264 GIT_ALTERNATE_OBJECT_DIRECTORIES
 265 .RS 4
 266 used to specify additional object database roots (usually unset)
 267 .RE
 268 .SH "GIT"
 269 .sp
 270 Part of the \fBgit\fR(1) suite