| blob | 451805404897c3d751368762583f22f3d4ea0351 |
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: 2023-08-09
6 .\" Manual: Git Manual
7 .\" Source: Git 2.42.0.rc1
8 .\" Language: English
9 .\"
10 .TH "GIT\-FSCK" "1" "2023\-08\-09" "Git 2\&.42\&.0\&.rc1" "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 .sp
135 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:
136 .PP
137 fsck\&.<msg\-id>
138 .RS 4
139 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
140 \fBtransfer\&.fsckObjects\fR
141 was set\&. This feature is intended to support working with legacy repositories containing such data\&.
142 .sp
143 Setting
144 \fBfsck\&.<msg\-id>\fR
145 will be picked up by
146 \fBgit-fsck\fR(1), but to accept pushes of such data set
147 \fBreceive\&.fsck\&.<msg\-id>\fR
148 instead, or to clone or fetch it set
149 \fBfetch\&.fsck\&.<msg\-id>\fR\&.
150 .sp
151 The rest of the documentation discusses
152 \fBfsck\&.*\fR
153 for brevity, but the same applies for the corresponding
154 \fBreceive\&.fsck\&.*\fR
155 and
156 \fBfetch\&.<msg\-id>\&.*\fR\&. variables\&.
157 .sp
158 Unlike variables like
159 \fBcolor\&.ui\fR
160 and
161 \fBcore\&.editor\fR
162 the
163 \fBreceive\&.fsck\&.<msg\-id>\fR
164 and
165 \fBfetch\&.fsck\&.<msg\-id>\fR
166 variables will not fall back on the
167 \fBfsck\&.<msg\-id>\fR
168 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\&.
169 .sp
170 When
171 \fBfsck\&.<msg\-id>\fR
172 is set, errors can be switched to warnings and vice versa by configuring the
173 \fBfsck\&.<msg\-id>\fR
174 setting where the
175 \fB<msg\-id>\fR
176 is the fsck message ID and the value is one of
177 \fBerror\fR,
178 \fBwarn\fR
179 or
180 \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
181 \fBfsck\&.missingEmail = ignore\fR
182 will hide that issue\&.
183 .sp
184 In general, it is better to enumerate existing objects with problems with
185 \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\&.
186 .sp
187 Setting an unknown
188 \fBfsck\&.<msg\-id>\fR
189 value will cause fsck to die, but doing the same for
190 \fBreceive\&.fsck\&.<msg\-id>\fR
191 and
192 \fBfetch\&.fsck\&.<msg\-id>\fR
193 will only cause git to warn\&.
194 .sp
195 See
196 \fBFsck Messages\fR
197 section of
198 \fBgit-fsck\fR(1)
199 for supported values of
200 \fB<msg\-id>\fR\&.
201 .RE
202 .PP
203 fsck\&.skipList
204 .RS 4
205 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\&.
206 .sp
207 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\&.
208 .sp
209 Like
210 \fBfsck\&.<msg\-id>\fR
211 this variable has corresponding
212 \fBreceive\&.fsck\&.skipList\fR
213 and
214 \fBfetch\&.fsck\&.skipList\fR
215 variants\&.
216 .sp
217 Unlike variables like
218 \fBcolor\&.ui\fR
219 and
220 \fBcore\&.editor\fR
221 the
222 \fBreceive\&.fsck\&.skipList\fR
223 and
224 \fBfetch\&.fsck\&.skipList\fR
225 variables will not fall back on the
226 \fBfsck\&.skipList\fR
227 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\&.
228 .sp
229 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\&.
230 .RE
231 .SH "DISCUSSION"
232 .sp
233 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)\&.
234 .sp
235 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)\&.
236 .sp
237 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)\&.
238 .SH "EXTRACTED DIAGNOSTICS"
239 .PP
240 unreachable <type> <object>
241 .RS 4
242 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\&.
243 .RE
244 .PP
245 missing <type> <object>
246 .RS 4
247 The <type> object <object>, is referred to but isn\(cqt present in the database\&.
248 .RE
249 .PP
250 dangling <type> <object>
251 .RS 4
252 The <type> object <object>, is present in the database but never
253 \fIdirectly\fR
254 used\&. A dangling commit could be a root node\&.
255 .RE
256 .PP
257 hash mismatch <object>
258 .RS 4
259 The database has an object whose hash doesn\(cqt match the object database value\&. This indicates a serious data integrity problem\&.
260 .RE
261 .SH "FSCK MESSAGES"
262 .sp
263 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\&.
264 .PP
265 \fBbadDate\fR
266 .RS 4
267 (ERROR) Invalid date format in an author/committer line\&.
268 .RE
269 .PP
270 \fBbadDateOverflow\fR
271 .RS 4
272 (ERROR) Invalid date value in an author/committer line\&.
273 .RE
274 .PP
275 \fBbadEmail\fR
276 .RS 4
277 (ERROR) Invalid email format in an author/committer line\&.
278 .RE
279 .PP
280 \fBbadFilemode\fR
281 .RS 4
282 (INFO) A tree contains a bad filemode entry\&.
283 .RE
284 .PP
285 \fBbadName\fR
286 .RS 4
287 (ERROR) An author/committer name is empty\&.
288 .RE
289 .PP
290 \fBbadObjectSha1\fR
291 .RS 4
292 (ERROR) An object has a bad sha1\&.
293 .RE
294 .PP
295 \fBbadParentSha1\fR
296 .RS 4
297 (ERROR) A commit object has a bad parent sha1\&.
298 .RE
299 .PP
300 \fBbadTagName\fR
301 .RS 4
302 (INFO) A tag has an invalid format\&.
303 .RE
304 .PP
305 \fBbadTimezone\fR
306 .RS 4
307 (ERROR) Found an invalid time zone in an author/committer line\&.
308 .RE
309 .PP
310 \fBbadTree\fR
311 .RS 4
312 (ERROR) A tree cannot be parsed\&.
313 .RE
314 .PP
315 \fBbadTreeSha1\fR
316 .RS 4
317 (ERROR) A tree has an invalid format\&.
318 .RE
319 .PP
320 \fBbadType\fR
321 .RS 4
322 (ERROR) Found an invalid object type\&.
323 .RE
324 .PP
325 \fBduplicateEntries\fR
326 .RS 4
327 (ERROR) A tree contains duplicate file entries\&.
328 .RE
329 .PP
330 \fBemptyName\fR
331 .RS 4
332 (WARN) A path contains an empty name\&.
333 .RE
334 .PP
335 \fBextraHeaderEntry\fR
336 .RS 4
337 (IGNORE) Extra headers found after
338 \fBtagger\fR\&.
339 .RE
340 .PP
341 \fBfullPathname\fR
342 .RS 4
343 (WARN) A path contains the full path starting with "/"\&.
344 .RE
345 .PP
346 \fBgitattributesBlob\fR
347 .RS 4
348 (ERROR) A non\-blob found at
349 \fB\&.gitattributes\fR\&.
350 .RE
351 .PP
352 \fBgitattributesLarge\fR
353 .RS 4
354 (ERROR) The
355 \fB\&.gitattributes\fR
356 blob is too large\&.
357 .RE
358 .PP
359 \fBgitattributesLineLength\fR
360 .RS 4
361 (ERROR) The
362 \fB\&.gitattributes\fR
363 blob contains too long lines\&.
364 .RE
365 .PP
366 \fBgitattributesMissing\fR
367 .RS 4
368 (ERROR) Unable to read
369 \fB\&.gitattributes\fR
370 blob\&.
371 .RE
372 .PP
373 \fBgitattributesSymlink\fR
374 .RS 4
375 (INFO)
376 \fB\&.gitattributes\fR
377 is a symlink\&.
378 .RE
379 .PP
380 \fBgitignoreSymlink\fR
381 .RS 4
382 (INFO)
383 \fB\&.gitignore\fR
384 is a symlink\&.
385 .RE
386 .PP
387 \fBgitmodulesBlob\fR
388 .RS 4
389 (ERROR) A non\-blob found at
390 \fB\&.gitmodules\fR\&.
391 .RE
392 .PP
393 \fBgitmodulesLarge\fR
394 .RS 4
395 (ERROR) The
396 \fB\&.gitmodules\fR
397 file is too large to parse\&.
398 .RE
399 .PP
400 \fBgitmodulesMissing\fR
401 .RS 4
402 (ERROR) Unable to read
403 \fB\&.gitmodules\fR
404 blob\&.
405 .RE
406 .PP
407 \fBgitmodulesName\fR
408 .RS 4
409 (ERROR) A submodule name is invalid\&.
410 .RE
411 .PP
412 \fBgitmodulesParse\fR
413 .RS 4
414 (INFO) Could not parse
415 \fB\&.gitmodules\fR
416 blob\&.
417 .RE
418 .sp
419 \fBgitmodulesLarge\fR; (ERROR) \fB\&.gitmodules\fR blob is too large to parse\&.
420 .PP
421 \fBgitmodulesPath\fR
422 .RS 4
423 (ERROR)
424 \fB\&.gitmodules\fR
425 path is invalid\&.
426 .RE
427 .PP
428 \fBgitmodulesSymlink\fR
429 .RS 4
430 (ERROR)
431 \fB\&.gitmodules\fR
432 is a symlink\&.
433 .RE
434 .PP
435 \fBgitmodulesUpdate\fR
436 .RS 4
437 (ERROR) Found an invalid submodule update setting\&.
438 .RE
439 .PP
440 \fBgitmodulesUrl\fR
441 .RS 4
442 (ERROR) Found an invalid submodule url\&.
443 .RE
444 .PP
445 \fBhasDot\fR
446 .RS 4
447 (WARN) A tree contains an entry named
448 \fB\&.\fR\&.
449 .RE
450 .PP
451 \fBhasDotdot\fR
452 .RS 4
453 (WARN) A tree contains an entry named
454 \fB\&.\&.\fR\&.
455 .RE
456 .PP
457 \fBhasDotgit\fR
458 .RS 4
459 (WARN) A tree contains an entry named
460 \fB\&.git\fR\&.
461 .RE
462 .PP
463 \fBmailmapSymlink\fR
464 .RS 4
465 (INFO)
466 \fB\&.mailmap\fR
467 is a symlink\&.
468 .RE
469 .PP
470 \fBmissingAuthor\fR
471 .RS 4
472 (ERROR) Author is missing\&.
473 .RE
474 .PP
475 \fBmissingCommitter\fR
476 .RS 4
477 (ERROR) Committer is missing\&.
478 .RE
479 .PP
480 \fBmissingEmail\fR
481 .RS 4
482 (ERROR) Email is missing in an author/committer line\&.
483 .RE
484 .PP
485 \fBmissingNameBeforeEmail\fR
486 .RS 4
487 (ERROR) Missing name before an email in an author/committer line\&.
488 .RE
489 .PP
490 \fBmissingObject\fR
491 .RS 4
492 (ERROR) Missing
493 \fBobject\fR
494 line in tag object\&.
495 .RE
496 .PP
497 \fBmissingSpaceBeforeDate\fR
498 .RS 4
499 (ERROR) Missing space before date in an author/committer line\&.
500 .RE
501 .PP
502 \fBmissingSpaceBeforeEmail\fR
503 .RS 4
504 (ERROR) Missing space before the email in author/committer line\&.
505 .RE
506 .PP
507 \fBmissingTag\fR
508 .RS 4
509 (ERROR) Unexpected end after
510 \fBtype\fR
511 line in a tag object\&.
512 .RE
513 .PP
514 \fBmissingTagEntry\fR
515 .RS 4
516 (ERROR) Missing
517 \fBtag\fR
518 line in a tag object\&.
519 .RE
520 .PP
521 \fBmissingTaggerEntry\fR
522 .RS 4
523 (INFO) Missing
524 \fBtagger\fR
525 line in a tag object\&.
526 .RE
527 .PP
528 \fBmissingTree\fR
529 .RS 4
530 (ERROR) Missing
531 \fBtree\fR
532 line in a commit object\&.
533 .RE
534 .PP
535 \fBmissingType\fR
536 .RS 4
537 (ERROR) Invalid type value on the
538 \fBtype\fR
539 line in a tag object\&.
540 .RE
541 .PP
542 \fBmissingTypeEntry\fR
543 .RS 4
544 (ERROR) Missing
545 \fBtype\fR
546 line in a tag object\&.
547 .RE
548 .PP
549 \fBmultipleAuthors\fR
550 .RS 4
551 (ERROR) Multiple author lines found in a commit\&.
552 .RE
553 .PP
554 \fBnulInCommit\fR
555 .RS 4
556 (WARN) Found a NUL byte in the commit object body\&.
557 .RE
558 .PP
559 \fBnulInHeader\fR
560 .RS 4
561 (FATAL) NUL byte exists in the object header\&.
562 .RE
563 .PP
564 \fBnullSha1\fR
565 .RS 4
566 (WARN) Tree contains entries pointing to a null sha1\&.
567 .RE
568 .PP
569 \fBtreeNotSorted\fR
570 .RS 4
571 (ERROR) A tree is not properly sorted\&.
572 .RE
573 .PP
574 \fBunknownType\fR
575 .RS 4
576 (ERROR) Found an unknown object type\&.
577 .RE
578 .PP
579 \fBunterminatedHeader\fR
580 .RS 4
581 (FATAL) Missing end\-of\-line in the object header\&.
582 .RE
583 .PP
584 \fBzeroPaddedDate\fR
585 .RS 4
586 (ERROR) Found a zero padded date in an author/commiter line\&.
587 .RE
588 .PP
589 \fBzeroPaddedFilemode\fR
590 .RS 4
591 (WARN) Found a zero padded filemode in a tree\&.
592 .RE
593 .SH "ENVIRONMENT VARIABLES"
594 .PP
595 GIT_OBJECT_DIRECTORY
596 .RS 4
597 used to specify the object database root (usually $GIT_DIR/objects)
598 .RE
599 .PP
600 GIT_INDEX_FILE
601 .RS 4
602 used to specify the index file of the index
603 .RE
604 .PP
605 GIT_ALTERNATE_OBJECT_DIRECTORIES
606 .RS 4
607 used to specify additional object database roots (usually unset)
608 .RE
609 .SH "GIT"
610 .sp
611 Part of the \fBgit\fR(1) suite