gitweb: Handle non UTF-8 text better
[git/git.git] / Documentation / git-fsck.txt
CommitLineData
df391b19
JH
1git-fsck(1)
2===========
3
4NAME
5----
6git-fsck - Verifies the connectivity and validity of the objects in the database
7
8
9SYNOPSIS
10--------
11[verse]
566842f6 12'git-fsck' [--tags] [--root] [--unreachable] [--cache] [--no-reflogs]
df391b19
JH
13 [--full] [--strict] [<object>*]
14
15DESCRIPTION
16-----------
17Verifies the connectivity and validity of the objects in the database.
18
19OPTIONS
20-------
21<object>::
22 An object to treat as the head of an unreachability trace.
23+
24If no objects are given, git-fsck defaults to using the
25index file and all SHA1 references in .git/refs/* as heads.
26
27--unreachable::
28 Print out objects that exist but that aren't readable from any
29 of the reference nodes.
30
31--root::
32 Report root nodes.
33
34--tags::
35 Report tags.
36
37--cache::
38 Consider any object recorded in the index also as a head node for
39 an unreachability trace.
40
566842f6
SP
41--no-reflogs::
42 Do not consider commits that are referenced only by an
43 entry in a reflog to be reachable. This option is meant
44 only to search for commits that used to be in a ref, but
45 now aren't, but are still in that corresponding reflog.
46
df391b19
JH
47--full::
48 Check not just objects in GIT_OBJECT_DIRECTORY
49 ($GIT_DIR/objects), but also the ones found in alternate
50 object pools listed in GIT_ALTERNATE_OBJECT_DIRECTORIES
51 or $GIT_DIR/objects/info/alternates,
52 and in packed git archives found in $GIT_DIR/objects/pack
53 and corresponding pack subdirectories in alternate
54 object pools.
55
56--strict::
57 Enable more strict checking, namely to catch a file mode
58 recorded with g+w bit set, which was created by older
59 versions of git. Existing repositories, including the
60 Linux kernel, git itself, and sparse repository have old
61 objects that triggers this check, but it is recommended
62 to check new projects with this flag.
63
64It tests SHA1 and general object sanity, and it does full tracking of
65the resulting reachability and everything else. It prints out any
66corruption it finds (missing or bad objects), and if you use the
67'--unreachable' flag it will also print out objects that exist but
68that aren't readable from any of the specified head nodes.
69
70So for example
71
72 git-fsck --unreachable HEAD $(cat .git/refs/heads/*)
73
74will do quite a _lot_ of verification on the tree. There are a few
75extra validity tests to be added (make sure that tree objects are
76sorted properly etc), but on the whole if "git-fsck" is happy, you
77do have a valid tree.
78
79Any corrupt objects you will have to find in backups or other archives
80(i.e., you can just remove them and do an "rsync" with some other site in
81the hopes that somebody else has the object you have corrupted).
82
83Of course, "valid tree" doesn't mean that it wasn't generated by some
84evil person, and the end result might be crap. git is a revision
85tracking system, not a quality assurance system ;)
86
87Extracted Diagnostics
88---------------------
89
90expect dangling commits - potential heads - due to lack of head information::
91 You haven't specified any nodes as heads so it won't be
92 possible to differentiate between un-parented commits and
93 root nodes.
94
95missing sha1 directory '<dir>'::
96 The directory holding the sha1 objects is missing.
97
98unreachable <type> <object>::
99 The <type> object <object>, isn't actually referred to directly
100 or indirectly in any of the trees or commits seen. This can
101 mean that there's another root node that you're not specifying
102 or that the tree is corrupt. If you haven't missed a root node
103 then you might as well delete unreachable nodes since they
104 can't be used.
105
106missing <type> <object>::
107 The <type> object <object>, is referred to but isn't present in
108 the database.
109
110dangling <type> <object>::
111 The <type> object <object>, is present in the database but never
112 'directly' used. A dangling commit could be a root node.
113
114warning: git-fsck: tree <tree> has full pathnames in it::
115 And it shouldn't...
116
117sha1 mismatch <object>::
118 The database has an object who's sha1 doesn't match the
119 database value.
120 This indicates a serious data integrity problem.
121
122Environment Variables
123---------------------
124
125GIT_OBJECT_DIRECTORY::
126 used to specify the object database root (usually $GIT_DIR/objects)
127
128GIT_INDEX_FILE::
129 used to specify the index file of the index
130
131GIT_ALTERNATE_OBJECT_DIRECTORIES::
132 used to specify additional object database roots (usually unset)
133
134Author
135------
136Written by Linus Torvalds <torvalds@osdl.org>
137
138Documentation
139--------------
140Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
141
142GIT
143---
144Part of the gitlink:git[7] suite
145