1 git-fsck-cache(1)
2 =================
3 v0.1, May 2005
5 NAME
6 ----
7 git-fsck-cache - Verifies the connectivity and validity of the objects in the database
10 SYNOPSIS
11 --------
12 'git-fsck-cache' [--tags] [--root] [--unreachable] [--cache] [<object>*]
14 DESCRIPTION
15 -----------
16 Verifies the connectivity and validity of the objects in the database.
18 OPTIONS
19 -------
20 <object>::
21 An object to treat as the head of an unreachability trace.
23 If no objects are given, git-fsck-cache defaults to using the
24 index file and all SHA1 references in .git/refs/* as heads.
26 --unreachable::
27 Print out objects that exist but that aren't readable from any
28 of the reference nodes.
30 --root::
31 Report root nodes.
33 --tags::
34 Report tags.
36 --cache::
37 Consider any object recorded in the cache also as a head node for
38 an unreachability trace.
40 It tests SHA1 and general object sanity, and it does full tracking of
41 the resulting reachability and everything else. It prints out any
42 corruption it finds (missing or bad objects), and if you use the
43 '--unreachable' flag it will also print out objects that exist but
44 that aren't readable from any of the specified head nodes.
46 So for example
48 git-fsck-cache --unreachable $(cat .git/HEAD)
50 or, for Cogito users:
52 git-fsck-cache --unreachable $(cat .git/refs/heads/*)
54 will do quite a _lot_ of verification on the tree. There are a few
55 extra validity tests to be added (make sure that tree objects are
56 sorted properly etc), but on the whole if "git-fsck-cache" is happy, you
57 do have a valid tree.
59 Any corrupt objects you will have to find in backups or other archives
60 (ie you can just remove them and do an "rsync" with some other site in
61 the hopes that somebody else has the object you have corrupted).
63 Of course, "valid tree" doesn't mean that it wasn't generated by some
64 evil person, and the end result might be crap. Git is a revision
65 tracking system, not a quality assurance system ;)
67 Extracted Diagnostics
68 ---------------------
70 expect dangling commits - potential heads - due to lack of head information::
71 You haven't specified any nodes as heads so it won't be
72 possible to differentiate between un-parented commits and
73 root nodes.
75 missing sha1 directory '<dir>'::
76 The directory holding the sha1 objects is missing.
78 unreachable <type> <object>::
79 The <type> object <object>, isn't actually referred to directly
80 or indirectly in any of the trees or commits seen. This can
81 mean that there's another root node that you're not specifying
82 or that the tree is corrupt. If you haven't missed a root node
83 then you might as well delete unreachable nodes since they
84 can't be used.
86 missing <type> <object>::
87 The <type> object <object>, is referred to but isn't present in
88 the database.
90 dangling <type> <object>::
91 The <type> object <object>, is present in the database but never
92 'directly' used. A dangling commit could be a root node.
94 warning: git-fsck-cache: tree <tree> has full pathnames in it::
95 And it shouldn't...
97 sha1 mismatch <object>::
98 The database has an object who's sha1 doesn't match the
99 database value.
100 This indicates a serious data integrity problem.
101 (note: this error occured during early git development when
102 the database format changed.)
104 Environment Variables
105 ---------------------
107 GIT_OBJECT_DIRECTORY::
108 used to specify the object database root (usually .git/objects)
110 GIT_INDEX_FILE::
111 used to specify the cache
114 Author
115 ------
116 Written by Linus Torvalds <torvalds@osdl.org>
118 Documentation
119 --------------
120 Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
122 GIT
123 ---
124 Part of the link:git.html[git] suite