From: John Cai <johncai86@xxxxxxxxx> 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@xxxxxxxxx> --- 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
