| blob | bdc5f76bb0fd0e53f2bfa85a990b5dc25b71a236 |
1 '\" t
2 .\" Title: git-fsck
3 .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
4 .\" Generator: DocBook XSL Stylesheets v1.79.2 <http://docbook.sf.net/>
5 .\" Date: 2024-09-25
6 .\" Manual: Git Manual
7 .\" Source: Git 2.47.0.rc0
8 .\" Language: English
9 .\"
10 .TH "GIT\-FSCK" "1" "2024-09-25" "Git 2\&.47\&.0\&.rc0" "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 .SH "DESCRIPTION"
41 .sp
42 Verifies the connectivity and validity of the objects in the database\&.
43 .SH "OPTIONS"
44 .PP
45 <object>
46 .RS 4
47 An object to treat as the head of an unreachability trace\&.
48 .sp
49 If no objects are given,
50 \fIgit fsck\fR
51 defaults to using the index file, all SHA\-1 references in the
52 \fBrefs\fR
53 namespace, and all reflogs (unless \-\-no\-reflogs is given) as heads\&.
54 .RE
55 .PP
56 \-\-unreachable
57 .RS 4
58 Print out objects that exist but that aren\(cqt reachable from any of the reference nodes\&.
59 .RE
60 .PP
61 \-\-[no\-]dangling
62 .RS 4
63 Print objects that exist but that are never
64 \fIdirectly\fR
65 used (default)\&.
66 \fB\-\-no\-dangling\fR
67 can be used to omit this information from the output\&.
68 .RE
69 .PP
70 \-\-root
71 .RS 4
72 Report root nodes\&.
73 .RE
74 .PP
75 \-\-tags
76 .RS 4
77 Report tags\&.
78 .RE
79 .PP
80 \-\-cache
81 .RS 4
82 Consider any object recorded in the index also as a head node for an unreachability trace\&.
83 .RE
84 .PP
85 \-\-no\-reflogs
86 .RS 4
87 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\&.
88 .RE
89 .PP
90 \-\-full
91 .RS 4
92 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\&.
93 .RE
94 .PP
95 \-\-connectivity\-only
96 .RS 4
97 Check only the connectivity of reachable objects, making sure that any objects referenced by a reachable tag, commit, or tree are 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\&.
98 .sp
99 Unreachable tags, commits, and trees will also be accessed to find the tips of dangling segments of history\&. Use
100 \fB\-\-no\-dangling\fR
101 if you don\(cqt care about this output and want to speed it up further\&.
102 .RE
103 .PP
104 \-\-strict
105 .RS 4
106 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 trigger this check, but it is recommended to check new projects with this flag\&.
107 .RE
108 .PP
109 \-\-verbose
110 .RS 4
111 Be chatty\&.
112 .RE
113 .PP
114 \-\-lost\-found
115 .RS 4
116 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\&.
117 .RE
118 .PP
119 \-\-name\-objects
120 .RS 4
121 When displaying names of reachable objects, in addition to the SHA\-1 also display a name that describes
122 \fBhow\fR
123 they are reachable, compatible with
124 \fBgit-rev-parse\fR(1), e\&.g\&.
125 \fBHEAD@{1234567890}~25^2:src/\fR\&.
126 .RE
127 .PP
128 \-\-[no\-]progress
129 .RS 4
130 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\&.
131 .RE
132 .SH "CONFIGURATION"
133 .sp
134 Everything below this line in this section is selectively included from the \fBgit-config\fR(1) documentation\&. The content is the same as what\(cqs found there:
135 .PP
136 fsck\&.<msg\-id>
137 .RS 4
138 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
139 \fBtransfer\&.fsckObjects\fR
140 was set\&. This feature is intended to support working with legacy repositories containing such data\&.
141 .sp
142 Setting
143 \fBfsck\&.<msg\-id>\fR
144 will be picked up by
145 \fBgit-fsck\fR(1), but to accept pushes of such data set
146 \fBreceive\&.fsck\&.<msg\-id>\fR
147 instead, or to clone or fetch it set
148 \fBfetch\&.fsck\&.<msg\-id>\fR\&.
149 .sp
150 The rest of the documentation discusses
151 \fBfsck\&.*\fR
152 for brevity, but the same applies for the corresponding
153 \fBreceive\&.fsck\&.*\fR
154 and
155 \fBfetch\&.fsck\&.*\fR\&. variables\&.
156 .sp
157 Unlike variables like
158 \fBcolor\&.ui\fR
159 and
160 \fBcore\&.editor\fR, 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 must be 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 .sp
193 See the
194 \fBFsck Messages\fR
195 section of
196 \fBgit-fsck\fR(1)
197 for supported values of
198 \fB<msg\-id>\fR\&.
199 .RE
200 .PP
201 fsck\&.skipList
202 .RS 4
203 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 are ignored\&. Everything but a SHA\-1 per line will error out on older versions\&.
204 .sp
205 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\&.
206 .sp
207 Like
208 \fBfsck\&.<msg\-id>\fR
209 this variable has corresponding
210 \fBreceive\&.fsck\&.skipList\fR
211 and
212 \fBfetch\&.fsck\&.skipList\fR
213 variants\&.
214 .sp
215 Unlike variables like
216 \fBcolor\&.ui\fR
217 and
218 \fBcore\&.editor\fR
219 the
220 \fBreceive\&.fsck\&.skipList\fR
221 and
222 \fBfetch\&.fsck\&.skipList\fR
223 variables will not fall back on the
224 \fBfsck\&.skipList\fR
225 configuration if they aren\(cqt set\&. To uniformly configure the same fsck settings in different circumstances, all three of them must be set to the same values\&.
226 .sp
227 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\&.
228 .RE
229 .SH "DISCUSSION"
230 .sp
231 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)\&.
232 .sp
233 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)\&.
234 .sp
235 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)\&.
236 .SH "EXTRACTED DIAGNOSTICS"
237 .PP
238 unreachable <type> <object>
239 .RS 4
240 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\&.
241 .RE
242 .PP
243 missing <type> <object>
244 .RS 4
245 The <type> object <object>, is referred to but isn\(cqt present in the database\&.
246 .RE
247 .PP
248 dangling <type> <object>
249 .RS 4
250 The <type> object <object>, is present in the database but never
251 \fIdirectly\fR
252 used\&. A dangling commit could be a root node\&.
253 .RE
254 .PP
255 hash mismatch <object>
256 .RS 4
257 The database has an object whose hash doesn\(cqt match the object database value\&. This indicates a serious data integrity problem\&.
258 .RE
259 .SH "FSCK MESSAGES"
260 .sp
261 The following lists the types of errors \fBgit fsck\fR detects and what each error means, with their default severity\&. The severity of the error, other than those that are marked as "(FATAL)", can be tweaked by setting the corresponding \fBfsck\&.<msg\-id>\fR configuration variable\&.
262 .PP
263 \fBbadDate\fR
264 .RS 4
265 (ERROR) Invalid date format in an author/committer line\&.
266 .RE
267 .PP
268 \fBbadDateOverflow\fR
269 .RS 4
270 (ERROR) Invalid date value in an author/committer line\&.
271 .RE
272 .PP
273 \fBbadEmail\fR
274 .RS 4
275 (ERROR) Invalid email format in an author/committer line\&.
276 .RE
277 .PP
278 \fBbadFilemode\fR
279 .RS 4
280 (INFO) A tree contains a bad filemode entry\&.
281 .RE
282 .PP
283 \fBbadName\fR
284 .RS 4
285 (ERROR) An author/committer name is empty\&.
286 .RE
287 .PP
288 \fBbadObjectSha1\fR
289 .RS 4
290 (ERROR) An object has a bad sha1\&.
291 .RE
292 .PP
293 \fBbadParentSha1\fR
294 .RS 4
295 (ERROR) A commit object has a bad parent sha1\&.
296 .RE
297 .PP
298 \fBbadRefFiletype\fR
299 .RS 4
300 (ERROR) A ref has a bad file type\&.
301 .RE
302 .PP
303 \fBbadRefName\fR
304 .RS 4
305 (ERROR) A ref has an invalid format\&.
306 .RE
307 .PP
308 \fBbadTagName\fR
309 .RS 4
310 (INFO) A tag has an invalid format\&.
311 .RE
312 .PP
313 \fBbadTimezone\fR
314 .RS 4
315 (ERROR) Found an invalid time zone in an author/committer line\&.
316 .RE
317 .PP
318 \fBbadTree\fR
319 .RS 4
320 (ERROR) A tree cannot be parsed\&.
321 .RE
322 .PP
323 \fBbadTreeSha1\fR
324 .RS 4
325 (ERROR) A tree has an invalid format\&.
326 .RE
327 .PP
328 \fBbadType\fR
329 .RS 4
330 (ERROR) Found an invalid object type\&.
331 .RE
332 .PP
333 \fBduplicateEntries\fR
334 .RS 4
335 (ERROR) A tree contains duplicate file entries\&.
336 .RE
337 .PP
338 \fBemptyName\fR
339 .RS 4
340 (WARN) A path contains an empty name\&.
341 .RE
342 .PP
343 \fBextraHeaderEntry\fR
344 .RS 4
345 (IGNORE) Extra headers found after
346 \fBtagger\fR\&.
347 .RE
348 .PP
349 \fBfullPathname\fR
350 .RS 4
351 (WARN) A path contains the full path starting with "/"\&.
352 .RE
353 .PP
354 \fBgitattributesBlob\fR
355 .RS 4
356 (ERROR) A non\-blob found at
357 \fB\&.gitattributes\fR\&.
358 .RE
359 .PP
360 \fBgitattributesLarge\fR
361 .RS 4
362 (ERROR) The
363 \fB\&.gitattributes\fR
364 blob is too large\&.
365 .RE
366 .PP
367 \fBgitattributesLineLength\fR
368 .RS 4
369 (ERROR) The
370 \fB\&.gitattributes\fR
371 blob contains too long lines\&.
372 .RE
373 .PP
374 \fBgitattributesMissing\fR
375 .RS 4
376 (ERROR) Unable to read
377 \fB\&.gitattributes\fR
378 blob\&.
379 .RE
380 .PP
381 \fBgitattributesSymlink\fR
382 .RS 4
383 (INFO)
384 \fB\&.gitattributes\fR
385 is a symlink\&.
386 .RE
387 .PP
388 \fBgitignoreSymlink\fR
389 .RS 4
390 (INFO)
391 \fB\&.gitignore\fR
392 is a symlink\&.
393 .RE
394 .PP
395 \fBgitmodulesBlob\fR
396 .RS 4
397 (ERROR) A non\-blob found at
398 \fB\&.gitmodules\fR\&.
399 .RE
400 .PP
401 \fBgitmodulesLarge\fR
402 .RS 4
403 (ERROR) The
404 \fB\&.gitmodules\fR
405 file is too large to parse\&.
406 .RE
407 .PP
408 \fBgitmodulesMissing\fR
409 .RS 4
410 (ERROR) Unable to read
411 \fB\&.gitmodules\fR
412 blob\&.
413 .RE
414 .PP
415 \fBgitmodulesName\fR
416 .RS 4
417 (ERROR) A submodule name is invalid\&.
418 .RE
419 .PP
420 \fBgitmodulesParse\fR
421 .RS 4
422 (INFO) Could not parse
423 \fB\&.gitmodules\fR
424 blob\&.
425 .RE
426 .sp
427 \fBgitmodulesLarge\fR; (ERROR) \fB\&.gitmodules\fR blob is too large to parse\&.
428 .PP
429 \fBgitmodulesPath\fR
430 .RS 4
431 (ERROR)
432 \fB\&.gitmodules\fR
433 path is invalid\&.
434 .RE
435 .PP
436 \fBgitmodulesSymlink\fR
437 .RS 4
438 (ERROR)
439 \fB\&.gitmodules\fR
440 is a symlink\&.
441 .RE
442 .PP
443 \fBgitmodulesUpdate\fR
444 .RS 4
445 (ERROR) Found an invalid submodule update setting\&.
446 .RE
447 .PP
448 \fBgitmodulesUrl\fR
449 .RS 4
450 (ERROR) Found an invalid submodule url\&.
451 .RE
452 .PP
453 \fBhasDot\fR
454 .RS 4
455 (WARN) A tree contains an entry named
456 \fB\&.\fR\&.
457 .RE
458 .PP
459 \fBhasDotdot\fR
460 .RS 4
461 (WARN) A tree contains an entry named
462 \fB\&.\&.\fR\&.
463 .RE
464 .PP
465 \fBhasDotgit\fR
466 .RS 4
467 (WARN) A tree contains an entry named
468 \fB\&.git\fR\&.
469 .RE
470 .PP
471 \fBlargePathname\fR
472 .RS 4
473 (WARN) A tree contains an entry with a very long path name\&. If the value of
474 \fBfsck\&.largePathname\fR
475 contains a colon, that value is used as the maximum allowable length (e\&.g\&., "warn:10" would complain about any path component of 11 or more bytes)\&. The default value is 4096\&.
476 .RE
477 .PP
478 \fBmailmapSymlink\fR
479 .RS 4
480 (INFO)
481 \fB\&.mailmap\fR
482 is a symlink\&.
483 .RE
484 .PP
485 \fBmissingAuthor\fR
486 .RS 4
487 (ERROR) Author is missing\&.
488 .RE
489 .PP
490 \fBmissingCommitter\fR
491 .RS 4
492 (ERROR) Committer is missing\&.
493 .RE
494 .PP
495 \fBmissingEmail\fR
496 .RS 4
497 (ERROR) Email is missing in an author/committer line\&.
498 .RE
499 .PP
500 \fBmissingNameBeforeEmail\fR
501 .RS 4
502 (ERROR) Missing name before an email in an author/committer line\&.
503 .RE
504 .PP
505 \fBmissingObject\fR
506 .RS 4
507 (ERROR) Missing
508 \fBobject\fR
509 line in tag object\&.
510 .RE
511 .PP
512 \fBmissingSpaceBeforeDate\fR
513 .RS 4
514 (ERROR) Missing space before date in an author/committer line\&.
515 .RE
516 .PP
517 \fBmissingSpaceBeforeEmail\fR
518 .RS 4
519 (ERROR) Missing space before the email in an author/committer line\&.
520 .RE
521 .PP
522 \fBmissingTag\fR
523 .RS 4
524 (ERROR) Unexpected end after
525 \fBtype\fR
526 line in a tag object\&.
527 .RE
528 .PP
529 \fBmissingTagEntry\fR
530 .RS 4
531 (ERROR) Missing
532 \fBtag\fR
533 line in a tag object\&.
534 .RE
535 .PP
536 \fBmissingTaggerEntry\fR
537 .RS 4
538 (INFO) Missing
539 \fBtagger\fR
540 line in a tag object\&.
541 .RE
542 .PP
543 \fBmissingTree\fR
544 .RS 4
545 (ERROR) Missing
546 \fBtree\fR
547 line in a commit object\&.
548 .RE
549 .PP
550 \fBmissingType\fR
551 .RS 4
552 (ERROR) Invalid type value on the
553 \fBtype\fR
554 line in a tag object\&.
555 .RE
556 .PP
557 \fBmissingTypeEntry\fR
558 .RS 4
559 (ERROR) Missing
560 \fBtype\fR
561 line in a tag object\&.
562 .RE
563 .PP
564 \fBmultipleAuthors\fR
565 .RS 4
566 (ERROR) Multiple author lines found in a commit\&.
567 .RE
568 .PP
569 \fBnulInCommit\fR
570 .RS 4
571 (WARN) Found a NUL byte in the commit object body\&.
572 .RE
573 .PP
574 \fBnulInHeader\fR
575 .RS 4
576 (FATAL) NUL byte exists in the object header\&.
577 .RE
578 .PP
579 \fBnullSha1\fR
580 .RS 4
581 (WARN) Tree contains entries pointing to a null sha1\&.
582 .RE
583 .PP
584 \fBtreeNotSorted\fR
585 .RS 4
586 (ERROR) A tree is not properly sorted\&.
587 .RE
588 .PP
589 \fBunknownType\fR
590 .RS 4
591 (ERROR) Found an unknown object type\&.
592 .RE
593 .PP
594 \fBunterminatedHeader\fR
595 .RS 4
596 (FATAL) Missing end\-of\-line in the object header\&.
597 .RE
598 .PP
599 \fBzeroPaddedDate\fR
600 .RS 4
601 (ERROR) Found a zero padded date in an author/committer line\&.
602 .RE
603 .PP
604 \fBzeroPaddedFilemode\fR
605 .RS 4
606 (WARN) Found a zero padded filemode in a tree\&.
607 .RE
608 .SH "ENVIRONMENT VARIABLES"
609 .PP
610 GIT_OBJECT_DIRECTORY
611 .RS 4
612 used to specify the object database root (usually $GIT_DIR/objects)
613 .RE
614 .PP
615 GIT_INDEX_FILE
616 .RS 4
617 used to specify the index file of the index
618 .RE
619 .PP
620 GIT_ALTERNATE_OBJECT_DIRECTORIES
621 .RS 4
622 used to specify additional object database roots (usually unset)
623 .RE
624 .SH "GIT"
625 .sp
626 Part of the \fBgit\fR(1) suite