NAME
git-fsck - Verifies the connectivity and validity of the objects in the database
SYNOPSIS
- git fsck [--tags] [--root] [--unreachable] [--cache] [--no-reflogs]
- [--[no-]full] [--strict] [--verbose] [--lost-found]
- [--[no-]dangling] [--[no-]progress] [--connectivity-only]
- [--[no-]name-objects] [<object>*]
DESCRIPTION
Verifies the connectivity and validity of the objects in the database.
OPTIONS
CONFIGURATION
- fsck.
- During fsck git may find issues with legacy data whichwouldn’t be generated by current versions of git, and whichwouldn’t be sent over the wire if
transfer.fsckObjects
wasset. This feature is intended to support working with legacyrepositories containing such data.
Setting fsck.<msg-id>
will be picked up by git-fsck[1], butto accept pushes of such data set receive.fsck.<msg-id>
instead, orto clone or fetch it set fetch.fsck.<msg-id>
.
The rest of the documentation discusses fsck.
for brevity, but thesame applies for the corresponding receive.fsck.
andfetch.<msg-id>.*
. variables.
Unlike variables like color.ui
and core.editor
thereceive.fsck.<msg-id>
and fetch.fsck.<msg-id>
variables will notfall back on the fsck.<msg-id>
configuration if they aren’t set. Touniformly configure the same fsck settings in different circumstancesall three of them they must all set to the same values.
When fsck.<msg-id>
is set, errors can be switched to warnings andvice versa by configuring the fsck.<msg-id>
setting where the<msg-id>
is the fsck message ID and the value is one of error
,warn
or ignore
. For convenience, fsck prefixes the error/warningwith the message ID, e.g. "missingEmail: invalid author/committerline - missing email" means that setting fsck.missingEmail = ignore
will hide that issue.
In general, it is better to enumerate existing objects with problemswith fsck.skipList
, instead of listing the kind of breakages theseproblematic objects share to be ignored, as doing the latter willallow new instances of the same breakages go unnoticed.
Setting an unknown fsck.<msg-id>
value will cause fsck to die, butdoing the same for receive.fsck.<msg-id>
and fetch.fsck.<msg-id>
will only cause git to warn.
- fsck.skipList
- The path to a list of object names (i.e. one unabbreviated SHA-1 perline) that are known to be broken in a non-fatal way and shouldbe ignored. On versions of Git 2.20 and later comments (#), emptylines, and any leading and trailing whitespace is ignored. Everythingbut a SHA-1 per line will error out on older versions.
This feature is useful when an established project should be accepteddespite early commits containing errors that can be safely ignoredsuch as invalid committer email addresses. Note: corrupt objectscannot be skipped with this setting.
Like fsck.<msg-id>
this variable has correspondingreceive.fsck.skipList
and fetch.fsck.skipList
variants.
Unlike variables like color.ui
and core.editor
thereceive.fsck.skipList
and fetch.fsck.skipList
variables will notfall back on the fsck.skipList
configuration if they aren’t set. Touniformly configure the same fsck settings in different circumstancesall three of them they must all set to the same values.
Older versions of Git (before 2.20) documented that the object nameslist should be sorted. This was never a requirement, the object namescould appear in any order, but when reading the list we tracked whetherthe list was sorted for the purposes of an internal binary searchimplementation, which could save itself some work with an already sortedlist. Unless you had a humongous list there was no reason to go out ofyour way to pre-sort the list. After Git version 2.20 a hash implementationis used instead, so there’s now no reason to pre-sort the list.
DISCUSSION
git-fsck tests SHA-1 and general object sanity, and it does full trackingof the resulting reachability and everything else. It prints out anycorruption it finds (missing or bad objects), and if you use the—unreachable
flag it will also print out objects that exist but thataren’t reachable from any of the specified head nodes (or the defaultset, as mentioned above).
Any corrupt objects you will have to find in backups or other archives(i.e., you can just remove them and do an rsync with some other site inthe hopes that somebody else has the object you have corrupted).
If core.commitGraph is true, the commit-graph file will also be inspectedusing git commit-graph verify. See git-commit-graph[1].
Extracted Diagnostics
- expect dangling commits - potential heads - due to lack of head information
You haven’t specified any nodes as heads so it won’t bepossible to differentiate between un-parented commits androot nodes.
The directory holding the sha1 objects is missing.
Environment Variables
- GIT_OBJECT_DIRECTORY
used to specify the object database root (usually $GIT_DIR/objects)
used to specify the index file of the index
- used to specify additional object database roots (usually unset)
GIT
Part of the git[1] suite