Skip to content

document fsck error message ids

Junio C Hamano git 1 version In review

Get series with b4
b4 am [email protected]

Versions newest first

  1. v3 Latest4 patches 13 repliesIn review

Patches in v3 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/4fsck: remove the unused BAD_TAG_OBJECTfsck.h+0 -10 replies
2/4fsck: remove the unused MISSING_TREE_OBJECTfsck.h+0 -10 replies
3/4fsck: document msg-idDocumentation/config/fsck.txt Documentation/fsck-msgids.txt Documentation/git-fsck.txt +1 more+183 -00 replies
4/4Documentation: add lint-fsck-msgidsDocumentation/Makefile Documentation/lint-fsck-msgids.perl+81 -013 replies

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v3 yet.

Read the v3 thread

Cover letter [PATCH v3 0/4] document fsck error message ids

"git fsck" reports various anomalies it finds in the form of message tokens, like badDate, in its error message, and allows most of them to be tweaked for their severity levels via configuration varialbes, like fsck.badDate. We however do not have them centrally documented anywhere, other than the header file itself (and the header file does not have explanation on what they mean).

This is John's work, with a bit of help from me.

* Patches 1 and 2 remove fsck error message IDs from fsck.h that are not used in today's code.

* In patch 3, "git fsck --help" gains a section that lists all the fsck error message ids with explanation. "git config --help" gains a reference to the section.

* While we worked on patch 3, we made many small mistakes (like spelling the tokens with incorrect camelCasing, or failing to list a few messages), which revealed the need of automated tool to catch them. Patch 4 adds to "make check-docs" a mechanism to verify the documentation covers what is defined in fsck.h correctly.

Possible future directions that are left outside the scope of this topic are:

* "git config --help" may want to include the same list inline instead of having a reference to "git fsck --help".

* Instead of the lint-docs support, we may want to auto-generate the documentation from fsck.h.

John Cai (2):
fsck: remove the unused BAD_TAG_OBJECT
fsck: document msg-id

Junio C Hamano (2):
fsck: remove the unused MISSING_TREE_OBJECT
Documentation: add lint-fsck-msgids

 Documentation/Makefile              |  11 ++
 Documentation/config/fsck.txt       |   4 +
 Documentation/fsck-msgids.txt       | 161 ++++++++++++++++++++++++++++
 Documentation/git-fsck.txt          |  12 +++
 Documentation/lint-fsck-msgids.perl |  70 ++++++++++++
 fsck.h                              |   8 +-
 6 files changed, 264 insertions(+), 2 deletions(-)
 create mode 100644 Documentation/fsck-msgids.txt
 create mode 100755 Documentation/lint-fsck-msgids.perl
Signature · 1 line
2.38.1-359-g84c4c6d5a5