]>
Commit | Line | Data |
---|---|---|
df391b19 JH |
1 | git-fsck(1) |
2 | =========== | |
3 | ||
4 | NAME | |
5 | ---- | |
6 | git-fsck - Verifies the connectivity and validity of the objects in the database | |
7 | ||
8 | ||
9 | SYNOPSIS | |
10 | -------- | |
11 | [verse] | |
b1889c36 | 12 | 'git fsck' [--tags] [--root] [--unreachable] [--cache] [--no-reflogs] |
1e49f22f | 13 | [--[no-]full] [--strict] [--verbose] [--lost-found] |
90cf590f | 14 | [--[no-]dangling] [--[no-]progress] [--connectivity-only] |
a443b762 | 15 | [--[no-]name-objects] [<object>...] |
df391b19 JH |
16 | |
17 | DESCRIPTION | |
18 | ----------- | |
19 | Verifies the connectivity and validity of the objects in the database. | |
20 | ||
21 | OPTIONS | |
22 | ------- | |
23 | <object>:: | |
24 | An object to treat as the head of an unreachability trace. | |
25 | + | |
0b444cdb | 26 | If no objects are given, 'git fsck' defaults to using the |
d5fa1f1a | 27 | index file, all SHA-1 references in `refs` namespace, and all reflogs |
831e61f8 | 28 | (unless --no-reflogs is given) as heads. |
df391b19 JH |
29 | |
30 | --unreachable:: | |
43d532e6 | 31 | Print out objects that exist but that aren't reachable from any |
df391b19 JH |
32 | of the reference nodes. |
33 | ||
0460ed2c | 34 | --[no-]dangling:: |
c6a13b2c | 35 | Print objects that exist but that are never 'directly' used (default). |
a8747a10 | 36 | `--no-dangling` can be used to omit this information from the output. |
c6a13b2c | 37 | |
df391b19 JH |
38 | --root:: |
39 | Report root nodes. | |
40 | ||
41 | --tags:: | |
42 | Report tags. | |
43 | ||
44 | --cache:: | |
45 | Consider any object recorded in the index also as a head node for | |
46 | an unreachability trace. | |
47 | ||
566842f6 SP |
48 | --no-reflogs:: |
49 | Do not consider commits that are referenced only by an | |
50 | entry in a reflog to be reachable. This option is meant | |
51 | only to search for commits that used to be in a ref, but | |
52 | now aren't, but are still in that corresponding reflog. | |
53 | ||
df391b19 JH |
54 | --full:: |
55 | Check not just objects in GIT_OBJECT_DIRECTORY | |
56 | ($GIT_DIR/objects), but also the ones found in alternate | |
57 | object pools listed in GIT_ALTERNATE_OBJECT_DIRECTORIES | |
58 | or $GIT_DIR/objects/info/alternates, | |
2de9b711 | 59 | and in packed Git archives found in $GIT_DIR/objects/pack |
df391b19 | 60 | and corresponding pack subdirectories in alternate |
f29cd393 JH |
61 | object pools. This is now default; you can turn it off |
62 | with --no-full. | |
df391b19 | 63 | |
02976bf8 | 64 | --connectivity-only:: |
df805ed6 JK |
65 | Check only the connectivity of reachable objects, making sure |
66 | that any objects referenced by a reachable tag, commit, or tree | |
ce14cc0b | 67 | are present. This speeds up the operation by avoiding reading |
df805ed6 JK |
68 | blobs entirely (though it does still check that referenced blobs |
69 | exist). This will detect corruption in commits and trees, but | |
70 | not do any semantic checks (e.g., for format errors). Corruption | |
71 | in blob objects will not be detected at all. | |
8d8c2a5a JK |
72 | + |
73 | Unreachable tags, commits, and trees will also be accessed to find the | |
74 | tips of dangling segments of history. Use `--no-dangling` if you don't | |
75 | care about this output and want to speed it up further. | |
02976bf8 | 76 | |
df391b19 JH |
77 | --strict:: |
78 | Enable more strict checking, namely to catch a file mode | |
79 | recorded with g+w bit set, which was created by older | |
2de9b711 TA |
80 | versions of Git. Existing repositories, including the |
81 | Linux kernel, Git itself, and sparse repository have old | |
ce14cc0b | 82 | objects that trigger this check, but it is recommended |
df391b19 JH |
83 | to check new projects with this flag. |
84 | ||
20f1eb6b JS |
85 | --verbose:: |
86 | Be chatty. | |
87 | ||
68f6c019 | 88 | --lost-found:: |
16a7fcfe JS |
89 | Write dangling objects into .git/lost-found/commit/ or |
90 | .git/lost-found/other/, depending on type. If the object is | |
91 | a blob, the contents are written into the file, rather than | |
92 | its object name. | |
68f6c019 | 93 | |
90cf590f JS |
94 | --name-objects:: |
95 | When displaying names of reachable objects, in addition to the | |
96 | SHA-1 also display a name that describes *how* they are reachable, | |
97 | compatible with linkgit:git-rev-parse[1], e.g. | |
98 | `HEAD@{1234567890}~25^2:src/`. | |
99 | ||
0460ed2c | 100 | --[no-]progress:: |
1e49f22f NTND |
101 | Progress status is reported on the standard error stream by |
102 | default when it is attached to a terminal, unless | |
103 | --no-progress or --verbose is specified. --progress forces | |
104 | progress status even if the standard error stream is not | |
105 | directed to a terminal. | |
106 | ||
d61e6ce1 SG |
107 | CONFIGURATION |
108 | ------------- | |
109 | ||
18d89fe2 ÆAB |
110 | include::includes/cmd-config-section-all.txt[] |
111 | ||
d61e6ce1 SG |
112 | include::config/fsck.txt[] |
113 | ||
28303082 JK |
114 | DISCUSSION |
115 | ---------- | |
df391b19 | 116 | |
d5fa1f1a | 117 | git-fsck tests SHA-1 and general object sanity, and it does full tracking |
28303082 JK |
118 | of the resulting reachability and everything else. It prints out any |
119 | corruption it finds (missing or bad objects), and if you use the | |
bcf9626a | 120 | `--unreachable` flag it will also print out objects that exist but that |
28303082 JK |
121 | aren't reachable from any of the specified head nodes (or the default |
122 | set, as mentioned above). | |
df391b19 JH |
123 | |
124 | Any corrupt objects you will have to find in backups or other archives | |
2fd02c92 | 125 | (i.e., you can just remove them and do an 'rsync' with some other site in |
df391b19 JH |
126 | the hopes that somebody else has the object you have corrupted). |
127 | ||
e0fd51e1 DS |
128 | If core.commitGraph is true, the commit-graph file will also be inspected |
129 | using 'git commit-graph verify'. See linkgit:git-commit-graph[1]. | |
130 | ||
df391b19 JH |
131 | Extracted Diagnostics |
132 | --------------------- | |
133 | ||
df391b19 JH |
134 | unreachable <type> <object>:: |
135 | The <type> object <object>, isn't actually referred to directly | |
136 | or indirectly in any of the trees or commits seen. This can | |
137 | mean that there's another root node that you're not specifying | |
138 | or that the tree is corrupt. If you haven't missed a root node | |
139 | then you might as well delete unreachable nodes since they | |
140 | can't be used. | |
141 | ||
142 | missing <type> <object>:: | |
143 | The <type> object <object>, is referred to but isn't present in | |
144 | the database. | |
145 | ||
146 | dangling <type> <object>:: | |
147 | The <type> object <object>, is present in the database but never | |
148 | 'directly' used. A dangling commit could be a root node. | |
149 | ||
01f8d594 JK |
150 | hash mismatch <object>:: |
151 | The database has an object whose hash doesn't match the | |
152 | object database value. | |
df391b19 JH |
153 | This indicates a serious data integrity problem. |
154 | ||
f6534dbd JC |
155 | |
156 | FSCK MESSAGES | |
157 | ------------- | |
158 | ||
159 | The following lists the types of errors `git fsck` detects and what | |
160 | each error means, with their default severity. The severity of the | |
161 | error, other than those that are marked as "(FATAL)", can be tweaked | |
162 | by setting the corresponding `fsck.<msg-id>` configuration variable. | |
163 | ||
164 | include::fsck-msgids.txt[] | |
165 | ||
166 | ||
df391b19 JH |
167 | Environment Variables |
168 | --------------------- | |
169 | ||
170 | GIT_OBJECT_DIRECTORY:: | |
171 | used to specify the object database root (usually $GIT_DIR/objects) | |
172 | ||
173 | GIT_INDEX_FILE:: | |
174 | used to specify the index file of the index | |
175 | ||
176 | GIT_ALTERNATE_OBJECT_DIRECTORIES:: | |
177 | used to specify additional object database roots (usually unset) | |
178 | ||
df391b19 JH |
179 | GIT |
180 | --- | |
9e1f0a85 | 181 | Part of the linkgit:git[1] suite |