From: "John Cai via GitGitGadget" <gitgitgadget@gmail.com>
To: git@vger.kernel.org
Cc: John Cai <johncai86@gmail.com>, John Cai <johncai86@gmail.com>
Subject: [PATCH 2/2] fsck: document msg-id
Date: Mon, 24 Oct 2022 15:00:38 +0000 [thread overview]
Message-ID: <3aec3d2c9ca65a37a367c3a7c9081bbd4cd44ae0.1666623639.git.gitgitgadget@gmail.com> (raw)
In-Reply-To: <pull.1369.git.git.1666623639.gitgitgadget@gmail.com>
From: John Cai <johncai86@gmail.com>
The git-config 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 section under the docs for fsck.<msg-id> with the msg-ids that
git-fsck recognizes.
Signed-off-by: John Cai <johncai86@gmail.com>
---
Documentation/config/fsck.txt | 5 ++
Documentation/fsck-msgids.txt | 133 ++++++++++++++++++++++++++++++++++
2 files changed, 138 insertions(+)
create mode 100644 Documentation/fsck-msgids.txt
diff --git a/Documentation/config/fsck.txt b/Documentation/config/fsck.txt
index 450e8c38e34..b0632075f22 100644
--- a/Documentation/config/fsck.txt
+++ b/Documentation/config/fsck.txt
@@ -35,6 +35,11 @@ allow new instances of the same breakages go unnoticed.
Setting an unknown `fsck.<msg-id>` value will cause fsck to die, but
doing the same for `receive.fsck.<msg-id>` and `fetch.fsck.<msg-id>`
will only cause git to warn.
++
+The following `<msg-id>` are supported:
++
+
+include::../fsck-msgids.txt[]
fsck.skipList::
The path to a list of object names (i.e. one unabbreviated SHA-1 per
diff --git a/Documentation/fsck-msgids.txt b/Documentation/fsck-msgids.txt
new file mode 100644
index 00000000000..888fa3308b7
--- /dev/null
+++ b/Documentation/fsck-msgids.txt
@@ -0,0 +1,133 @@
+--
+`badDate`;;
+ Invalid date format in an author/committer line.
+
+`badEmail`;;
+ Invalid email format in an author/committer line.
+
+`badFilemode`;;
+ A tree contains a bad filemode entry.
+
+`badName`;;
+ An author/committer name is empty.
+
+`badObjectSha1`;;
+ An object has a bad sha1.
+
+`badParentSha1`;;
+ A commit object has a bad parent sha1.
+
+`badTagName`;;
+ A tag has an invalid format.
+
+`badTimezone`;;
+ Found an invalid time zone in an author/committer line.
+
+`badTree`;;
+ A tree cannot be parsed.
+
+`badTreeSha1`;;
+ A tree has an invalid format.
+
+`badType`;;
+ Found an invalid object type.
+
+`duplicateEntries`;;
+ A tree contains duplicate file entries.
+
+`emptyName`;;
+ A path contains an empty name.
+
+`fullPathName`;;
+ A path contains the full path starting with "/".
+
+`gitAttributesSymlink`;;
+ `.gitattributes` is a symlink.
+
+`gitignoreSymlink`;;
+ `.gitignore` is a symlink.
+
+`gitmodulesBlob`;;
+ A non-blob found at `.gitmodules`.
+
+`gitmodulesMissing`;;
+ Unable to read `.gitmodules` blob.
+
+`gitmodulesName`;;
+ A submodule name is invalid.
+
+`gitmodulesParse`;;
+ Could not parse `.gitmodules` blob.
+
+`gitmodulesLarge`;
+ `.gitmodules` blob is too large to parse.
+
+`gitmodulesPath`;;
+ `.gitmodules` path is invalid.
+
+`gitmodulesSymlink`;;
+ `.gitmodules` is a symlink.
+
+`gitmodulesUpdate`;;
+ Found an invalid submodule update setting.
+
+`gitmodulesUrl`;;
+ Found an invalid submodule url.
+
+`hasDot`;;
+ A tree contains an entry named `.`.
+
+`hasDotdot`;;
+ A tree contains an entry named `..`.
+
+`hasDotgit`;;
+ A tree contains an entry named `.git`.
+
+`mailmapSymlink`;;
+ `.mailmap` is a symlink.
+
+`missingAuthor`;;
+ Author is missing.
+
+`missingCommitter`;;
+ Committer is missing.
+
+`missingEmail`;;
+ Email is missing in an author/committer line.
+
+`missingNameBeforeEmail`;;
+ Missing space before an email in an author/committer line.
+
+`missingObject`;;
+ Missing `object` line in tag object.
+
+`missingSpaceBeforeDate`;;
+ Missing space before date in an author/committer line.
+
+`missingSpaceBeforeEmail`;;
+ Missing space before the email in author/committer line.
+
+`missingTag`;;
+ Unexpected end after `type` line in a tag object.
+
+`missingTypeEntry`;;
+ Missing `type` line in a tag object.
+
+`multipleAuthors`;;`
+ Multiple author lines found in a commit.
+
+`nulInCommit`;;
+ Found a NUL byte in the commit object body.
+
+`treeNotSorted`;;
+ A tree is not properly sorted.
+
+`unknownType`;;
+ Found an unknown object type.
+
+`zeroPaddingDate`;;
+ Found a zero padded date in an author/commiter line.
+
+`zeroPaddedFilemode`;;
+ Found a zero padded filemode in a tree.
+--
--
gitgitgadget
next prev parent reply other threads:[~2022-10-24 16:16 UTC|newest]
Thread overview: 35+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-10-24 15:00 [PATCH 0/2] Document fsck msg ids John Cai via GitGitGadget
2022-10-24 15:00 ` [PATCH 1/2] fsck: remove the unused BAD_TAG_OBJECT John Cai via GitGitGadget
2022-10-24 16:57 ` Junio C Hamano
2022-10-24 18:16 ` Junio C Hamano
2022-10-24 18:33 ` John Cai
2022-10-24 23:39 ` Jeff King
2022-10-24 15:00 ` John Cai via GitGitGadget [this message]
2022-10-24 17:33 ` [PATCH 2/2] fsck: document msg-id Junio C Hamano
2022-10-25 9:41 ` Ævar Arnfjörð Bjarmason
2022-10-25 16:07 ` Junio C Hamano
2022-10-24 18:51 ` [PATCH 0/2] Document fsck msg ids Junio C Hamano
2022-10-25 3:17 ` [PATCH v2 " John Cai via GitGitGadget
2022-10-25 3:17 ` [PATCH v2 1/2] fsck: remove the unused BAD_TAG_OBJECT John Cai via GitGitGadget
2022-10-25 3:17 ` [PATCH v2 2/2] fsck: document msg-id John Cai via GitGitGadget
2022-10-25 4:30 ` [PATCH v2 0/2] Document fsck msg ids Junio C Hamano
2022-10-25 4:40 ` Junio C Hamano
2022-10-25 5:12 ` [PATCH] Documentation: add lint-fsck-msgids Junio C Hamano
2022-10-25 22:42 ` [PATCH v3 0/4] document fsck error message ids Junio C Hamano
2022-10-25 22:42 ` [PATCH v3 1/4] fsck: remove the unused BAD_TAG_OBJECT Junio C Hamano
2022-10-25 22:42 ` [PATCH v3 2/4] fsck: remove the unused MISSING_TREE_OBJECT Junio C Hamano
2022-10-25 22:42 ` [PATCH v3 3/4] fsck: document msg-id Junio C Hamano
2022-10-25 22:42 ` [PATCH v3 4/4] Documentation: add lint-fsck-msgids Junio C Hamano
2022-10-26 2:43 ` Ævar Arnfjörð Bjarmason
2022-10-26 5:34 ` Jeff King
2022-10-26 6:46 ` Junio C Hamano
2022-10-26 11:35 ` Ævar Arnfjörð Bjarmason
2022-10-28 1:23 ` Jeff King
2022-10-28 2:04 ` Ævar Arnfjörð Bjarmason
2022-10-28 5:32 ` Jeff King
2022-10-28 10:41 ` Ævar Arnfjörð Bjarmason
2022-10-28 3:02 ` John Cai
2022-10-28 3:11 ` Ævar Arnfjörð Bjarmason
2022-10-28 5:32 ` Junio C Hamano
2022-10-28 5:37 ` Jeff King
2022-10-28 5:35 ` Jeff King
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=3aec3d2c9ca65a37a367c3a7c9081bbd4cd44ae0.1666623639.git.gitgitgadget@gmail.com \
--to=gitgitgadget@gmail.com \
--cc=git@vger.kernel.org \
--cc=johncai86@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).