aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/git-fsck.txt
diff options
context:
space:
mode:
authorJohn Cai <johncai86@gmail.com>2022-10-25 15:42:23 -0700
committerJunio C Hamano <gitster@pobox.com>2022-10-25 15:44:18 -0700
commitf6534dbda474ce9c4ce06c1f3212745724dd1724 (patch)
treec5de190a23a24e013107b07bd6e4d0575e4de7ec /Documentation/git-fsck.txt
parent7edfb883abf46f514ca213efc4e04624d2ed540a (diff)
downloadgit-f6534dbda474ce9c4ce06c1f3212745724dd1724.tar.gz
fsck: document msg-id
The documentation lacks mention of specific <msg-id> that are supported. While git-help --config will display a list of these options, often developers' first instinct is to consult the git docs to find valid config values. Add a list of fsck error messages, and link to it from the git-fsck documentation. Signed-off-by: John Cai <johncai86@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-fsck.txt')
-rw-r--r--Documentation/git-fsck.txt12
1 files changed, 12 insertions, 0 deletions
diff --git a/Documentation/git-fsck.txt b/Documentation/git-fsck.txt
index 29318ea957..b6a0f8a085 100644
--- a/Documentation/git-fsck.txt
+++ b/Documentation/git-fsck.txt
@@ -152,6 +152,18 @@ hash mismatch <object>::
object database value.
This indicates a serious data integrity problem.
+
+FSCK MESSAGES
+-------------
+
+The following lists the types of errors `git fsck` detects and what
+each error means, with their default severity. The severity of the
+error, other than those that are marked as "(FATAL)", can be tweaked
+by setting the corresponding `fsck.<msg-id>` configuration variable.
+
+include::fsck-msgids.txt[]
+
+
Environment Variables
---------------------