2007-01-29 00:33:58 +00:00
|
|
|
git-fsck(1)
|
|
|
|
===========
|
|
|
|
|
|
|
|
NAME
|
|
|
|
----
|
|
|
|
git-fsck - Verifies the connectivity and validity of the objects in the database
|
|
|
|
|
|
|
|
|
|
|
|
SYNOPSIS
|
|
|
|
--------
|
|
|
|
[verse]
|
2008-06-30 06:09:04 +00:00
|
|
|
'git fsck' [--tags] [--root] [--unreachable] [--cache] [--no-reflogs]
|
2011-11-07 02:59:26 +00:00
|
|
|
[--[no-]full] [--strict] [--verbose] [--lost-found]
|
2016-07-17 11:00:02 +00:00
|
|
|
[--[no-]dangling] [--[no-]progress] [--connectivity-only]
|
2021-11-06 18:48:54 +00:00
|
|
|
[--[no-]name-objects] [<object>...]
|
2007-01-29 00:33:58 +00:00
|
|
|
|
|
|
|
DESCRIPTION
|
|
|
|
-----------
|
|
|
|
Verifies the connectivity and validity of the objects in the database.
|
|
|
|
|
|
|
|
OPTIONS
|
|
|
|
-------
|
|
|
|
<object>::
|
|
|
|
An object to treat as the head of an unreachability trace.
|
|
|
|
+
|
2010-01-09 23:33:00 +00:00
|
|
|
If no objects are given, 'git fsck' defaults to using the
|
2013-04-15 17:49:04 +00:00
|
|
|
index file, all SHA-1 references in `refs` namespace, and all reflogs
|
2012-08-06 20:36:47 +00:00
|
|
|
(unless --no-reflogs is given) as heads.
|
2007-01-29 00:33:58 +00:00
|
|
|
|
|
|
|
--unreachable::
|
2011-05-16 18:23:35 +00:00
|
|
|
Print out objects that exist but that aren't reachable from any
|
2007-01-29 00:33:58 +00:00
|
|
|
of the reference nodes.
|
|
|
|
|
2013-05-09 01:16:55 +00:00
|
|
|
--[no-]dangling::
|
2012-02-28 22:55:39 +00:00
|
|
|
Print objects that exist but that are never 'directly' used (default).
|
2012-03-05 19:32:08 +00:00
|
|
|
`--no-dangling` can be used to omit this information from the output.
|
2012-02-28 22:55:39 +00:00
|
|
|
|
2007-01-29 00:33:58 +00:00
|
|
|
--root::
|
|
|
|
Report root nodes.
|
|
|
|
|
|
|
|
--tags::
|
|
|
|
Report tags.
|
|
|
|
|
|
|
|
--cache::
|
|
|
|
Consider any object recorded in the index also as a head node for
|
|
|
|
an unreachability trace.
|
|
|
|
|
2007-04-04 14:46:14 +00:00
|
|
|
--no-reflogs::
|
|
|
|
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't, but are still in that corresponding reflog.
|
|
|
|
|
2007-01-29 00:33:58 +00:00
|
|
|
--full::
|
|
|
|
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,
|
2013-01-21 19:17:53 +00:00
|
|
|
and in packed Git archives found in $GIT_DIR/objects/pack
|
2007-01-29 00:33:58 +00:00
|
|
|
and corresponding pack subdirectories in alternate
|
2009-10-20 18:46:55 +00:00
|
|
|
object pools. This is now default; you can turn it off
|
|
|
|
with --no-full.
|
2007-01-29 00:33:58 +00:00
|
|
|
|
2015-06-22 15:27:12 +00:00
|
|
|
--connectivity-only::
|
2019-03-05 04:46:38 +00:00
|
|
|
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.
|
fsck: always compute USED flags for unreachable objects
The --connectivity-only option avoids opening every object, and instead
just marks reachable objects with a flag and compares this to the set
of all objects. This strategy is discussed in more detail in 3e3f8bd608
(fsck: prepare dummy objects for --connectivity-check, 2017-01-17).
This means that we report _every_ unreachable object as dangling.
Whereas in a full fsck, we'd have actually opened and parsed each of
those unreachable objects, marking their child objects with the USED
flag, to mean "this was mentioned by another object". And thus we can
report only the tip of an unreachable segment of the object graph as
dangling.
You can see this difference with a trivial example:
tree=$(git hash-object -t tree -w /dev/null)
one=$(echo one | git commit-tree $tree)
two=$(echo two | git commit-tree -p $one $tree)
Running `git fsck` will report only $two as dangling, but with
--connectivity-only, both commits (and the tree) are reported. Likewise,
using --lost-found would write all three objects.
We can make --connectivity-only work like the normal case by taking a
separate pass over the unreachable objects, parsing them and marking
objects they refer to as USED. That still avoids parsing any blobs,
though we do pay the cost to access any unreachable commits and trees
(which may or may not be noticeable, depending on how many you have).
If neither --dangling nor --lost-found is in effect, then we can skip
this step entirely, just like we do now. That makes "--connectivity-only
--no-dangling" just as fast as the current "--connectivity-only". I.e.,
we do the correct thing always, but you can still tweak the options to
make it faster if you don't care about dangling objects.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2019-03-05 04:47:39 +00:00
|
|
|
+
|
|
|
|
Unreachable tags, commits, and trees will also be accessed to find the
|
|
|
|
tips of dangling segments of history. Use `--no-dangling` if you don't
|
|
|
|
care about this output and want to speed it up further.
|
2015-06-22 15:27:12 +00:00
|
|
|
|
2007-01-29 00:33:58 +00:00
|
|
|
--strict::
|
|
|
|
Enable more strict checking, namely to catch a file mode
|
|
|
|
recorded with g+w bit set, which was created by older
|
2013-01-21 19:17:53 +00:00
|
|
|
versions of Git. Existing repositories, including the
|
|
|
|
Linux kernel, Git itself, and sparse repository have old
|
2007-01-29 00:33:58 +00:00
|
|
|
objects that triggers this check, but it is recommended
|
|
|
|
to check new projects with this flag.
|
|
|
|
|
2007-06-05 02:44:00 +00:00
|
|
|
--verbose::
|
|
|
|
Be chatty.
|
|
|
|
|
2007-07-03 00:33:54 +00:00
|
|
|
--lost-found::
|
2007-07-22 20:20:26 +00:00
|
|
|
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.
|
2007-07-03 00:33:54 +00:00
|
|
|
|
2016-07-17 11:00:02 +00:00
|
|
|
--name-objects::
|
|
|
|
When displaying names of reachable objects, in addition to the
|
|
|
|
SHA-1 also display a name that describes *how* they are reachable,
|
|
|
|
compatible with linkgit:git-rev-parse[1], e.g.
|
|
|
|
`HEAD@{1234567890}~25^2:src/`.
|
|
|
|
|
2013-05-09 01:16:55 +00:00
|
|
|
--[no-]progress::
|
2011-11-07 02:59:26 +00:00
|
|
|
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.
|
|
|
|
|
2019-07-29 09:59:14 +00:00
|
|
|
CONFIGURATION
|
|
|
|
-------------
|
|
|
|
|
|
|
|
include::config/fsck.txt[]
|
|
|
|
|
2011-12-16 11:33:10 +00:00
|
|
|
DISCUSSION
|
|
|
|
----------
|
2007-01-29 00:33:58 +00:00
|
|
|
|
2013-04-15 17:49:04 +00:00
|
|
|
git-fsck tests SHA-1 and general object sanity, and it does full tracking
|
2011-12-16 11:33:10 +00:00
|
|
|
of the resulting reachability and everything else. It prints out any
|
|
|
|
corruption it finds (missing or bad objects), and if you use the
|
2016-06-28 11:40:11 +00:00
|
|
|
`--unreachable` flag it will also print out objects that exist but that
|
2011-12-16 11:33:10 +00:00
|
|
|
aren't reachable from any of the specified head nodes (or the default
|
|
|
|
set, as mentioned above).
|
2007-01-29 00:33:58 +00:00
|
|
|
|
|
|
|
Any corrupt objects you will have to find in backups or other archives
|
2008-07-03 05:55:07 +00:00
|
|
|
(i.e., you can just remove them and do an 'rsync' with some other site in
|
2007-01-29 00:33:58 +00:00
|
|
|
the hopes that somebody else has the object you have corrupted).
|
|
|
|
|
2018-06-27 13:24:43 +00:00
|
|
|
If core.commitGraph is true, the commit-graph file will also be inspected
|
|
|
|
using 'git commit-graph verify'. See linkgit:git-commit-graph[1].
|
|
|
|
|
2007-01-29 00:33:58 +00:00
|
|
|
Extracted Diagnostics
|
|
|
|
---------------------
|
|
|
|
|
|
|
|
unreachable <type> <object>::
|
|
|
|
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.
|
|
|
|
|
|
|
|
missing <type> <object>::
|
|
|
|
The <type> object <object>, is referred to but isn't present in
|
|
|
|
the database.
|
|
|
|
|
|
|
|
dangling <type> <object>::
|
|
|
|
The <type> object <object>, is present in the database but never
|
|
|
|
'directly' used. A dangling commit could be a root node.
|
|
|
|
|
2019-01-07 08:40:34 +00:00
|
|
|
hash mismatch <object>::
|
|
|
|
The database has an object whose hash doesn't match the
|
|
|
|
object database value.
|
2007-01-29 00:33:58 +00:00
|
|
|
This indicates a serious data integrity problem.
|
|
|
|
|
|
|
|
Environment Variables
|
|
|
|
---------------------
|
|
|
|
|
|
|
|
GIT_OBJECT_DIRECTORY::
|
|
|
|
used to specify the object database root (usually $GIT_DIR/objects)
|
|
|
|
|
|
|
|
GIT_INDEX_FILE::
|
|
|
|
used to specify the index file of the index
|
|
|
|
|
|
|
|
GIT_ALTERNATE_OBJECT_DIRECTORIES::
|
|
|
|
used to specify additional object database roots (usually unset)
|
|
|
|
|
|
|
|
GIT
|
|
|
|
---
|
2008-06-06 07:07:32 +00:00
|
|
|
Part of the linkgit:git[1] suite
|