]> git.ipfire.org Git - thirdparty/git.git/blobdiff - fsck.h
t1415: set REFFILES for test specific to storage format
[thirdparty/git.git] / fsck.h
diff --git a/fsck.h b/fsck.h
index 733378f1260a89bcda654e1f6e2b5144e8d2ab3e..7202c3c87e8b94d3ba7811a21dca5cdbb46f81e5 100644 (file)
--- a/fsck.h
+++ b/fsck.h
@@ -3,15 +3,90 @@
 
 #include "oidset.h"
 
-#define FSCK_ERROR 1
-#define FSCK_WARN 2
-#define FSCK_IGNORE 3
+enum fsck_msg_type {
+       /* for internal use only */
+       FSCK_IGNORE,
+       FSCK_INFO,
+       FSCK_FATAL,
+       /* "public", fed to e.g. error_func callbacks */
+       FSCK_ERROR,
+       FSCK_WARN,
+};
+
+#define FOREACH_FSCK_MSG_ID(FUNC) \
+       /* fatal errors */ \
+       FUNC(NUL_IN_HEADER, FATAL) \
+       FUNC(UNTERMINATED_HEADER, FATAL) \
+       /* errors */ \
+       FUNC(BAD_DATE, ERROR) \
+       FUNC(BAD_DATE_OVERFLOW, ERROR) \
+       FUNC(BAD_EMAIL, ERROR) \
+       FUNC(BAD_NAME, ERROR) \
+       FUNC(BAD_OBJECT_SHA1, ERROR) \
+       FUNC(BAD_PARENT_SHA1, ERROR) \
+       FUNC(BAD_TAG_OBJECT, ERROR) \
+       FUNC(BAD_TIMEZONE, ERROR) \
+       FUNC(BAD_TREE, ERROR) \
+       FUNC(BAD_TREE_SHA1, ERROR) \
+       FUNC(BAD_TYPE, ERROR) \
+       FUNC(DUPLICATE_ENTRIES, ERROR) \
+       FUNC(MISSING_AUTHOR, ERROR) \
+       FUNC(MISSING_COMMITTER, ERROR) \
+       FUNC(MISSING_EMAIL, ERROR) \
+       FUNC(MISSING_NAME_BEFORE_EMAIL, ERROR) \
+       FUNC(MISSING_OBJECT, ERROR) \
+       FUNC(MISSING_SPACE_BEFORE_DATE, ERROR) \
+       FUNC(MISSING_SPACE_BEFORE_EMAIL, ERROR) \
+       FUNC(MISSING_TAG, ERROR) \
+       FUNC(MISSING_TAG_ENTRY, ERROR) \
+       FUNC(MISSING_TREE, ERROR) \
+       FUNC(MISSING_TREE_OBJECT, ERROR) \
+       FUNC(MISSING_TYPE, ERROR) \
+       FUNC(MISSING_TYPE_ENTRY, ERROR) \
+       FUNC(MULTIPLE_AUTHORS, ERROR) \
+       FUNC(TREE_NOT_SORTED, ERROR) \
+       FUNC(UNKNOWN_TYPE, ERROR) \
+       FUNC(ZERO_PADDED_DATE, ERROR) \
+       FUNC(GITMODULES_MISSING, ERROR) \
+       FUNC(GITMODULES_BLOB, ERROR) \
+       FUNC(GITMODULES_LARGE, ERROR) \
+       FUNC(GITMODULES_NAME, ERROR) \
+       FUNC(GITMODULES_SYMLINK, ERROR) \
+       FUNC(GITMODULES_URL, ERROR) \
+       FUNC(GITMODULES_PATH, ERROR) \
+       FUNC(GITMODULES_UPDATE, ERROR) \
+       /* warnings */ \
+       FUNC(BAD_FILEMODE, WARN) \
+       FUNC(EMPTY_NAME, WARN) \
+       FUNC(FULL_PATHNAME, WARN) \
+       FUNC(HAS_DOT, WARN) \
+       FUNC(HAS_DOTDOT, WARN) \
+       FUNC(HAS_DOTGIT, WARN) \
+       FUNC(NULL_SHA1, WARN) \
+       FUNC(ZERO_PADDED_FILEMODE, WARN) \
+       FUNC(NUL_IN_COMMIT, WARN) \
+       /* infos (reported as warnings, but ignored by default) */ \
+       FUNC(GITMODULES_PARSE, INFO) \
+       FUNC(BAD_TAG_NAME, INFO) \
+       FUNC(MISSING_TAGGER_ENTRY, INFO) \
+       /* ignored (elevated when requested) */ \
+       FUNC(EXTRA_HEADER_ENTRY, IGNORE)
+
+#define MSG_ID(id, msg_type) FSCK_MSG_##id,
+enum fsck_msg_id {
+       FOREACH_FSCK_MSG_ID(MSG_ID)
+       FSCK_MSG_MAX
+};
+#undef MSG_ID
 
 struct fsck_options;
 struct object;
 
+void fsck_set_msg_type_from_ids(struct fsck_options *options,
+                               enum fsck_msg_id msg_id,
+                               enum fsck_msg_type msg_type);
 void fsck_set_msg_type(struct fsck_options *options,
-               const char *msg_id, const char *msg_type);
+                      const char *msg_id, const char *msg_type);
 void fsck_set_msg_types(struct fsck_options *options, const char *values);
 int is_valid_msg_type(const char *msg_id, const char *msg_type);
 
@@ -23,28 +98,55 @@ int is_valid_msg_type(const char *msg_id, const char *msg_type);
  *     <0      error signaled and abort
  *     >0      error signaled and do not abort
  */
-typedef int (*fsck_walk_func)(struct object *obj, int type, void *data, struct fsck_options *options);
+typedef int (*fsck_walk_func)(struct object *obj, enum object_type object_type,
+                             void *data, struct fsck_options *options);
 
 /* callback for fsck_object, type is FSCK_ERROR or FSCK_WARN */
 typedef int (*fsck_error)(struct fsck_options *o,
                          const struct object_id *oid, enum object_type object_type,
-                         int msg_type, const char *message);
+                         enum fsck_msg_type msg_type, enum fsck_msg_id msg_id,
+                         const char *message);
 
 int fsck_error_function(struct fsck_options *o,
                        const struct object_id *oid, enum object_type object_type,
-                       int msg_type, const char *message);
+                       enum fsck_msg_type msg_type, enum fsck_msg_id msg_id,
+                       const char *message);
+int fsck_error_cb_print_missing_gitmodules(struct fsck_options *o,
+                                          const struct object_id *oid,
+                                          enum object_type object_type,
+                                          enum fsck_msg_type msg_type,
+                                          enum fsck_msg_id msg_id,
+                                          const char *message);
 
 struct fsck_options {
        fsck_walk_func walk;
        fsck_error error_func;
        unsigned strict:1;
-       int *msg_type;
+       enum fsck_msg_type *msg_type;
        struct oidset skiplist;
+       struct oidset gitmodules_found;
+       struct oidset gitmodules_done;
        kh_oid_map_t *object_names;
 };
 
-#define FSCK_OPTIONS_DEFAULT { NULL, fsck_error_function, 0, NULL, OIDSET_INIT }
-#define FSCK_OPTIONS_STRICT { NULL, fsck_error_function, 1, NULL, OIDSET_INIT }
+#define FSCK_OPTIONS_DEFAULT { \
+       .skiplist = OIDSET_INIT, \
+       .gitmodules_found = OIDSET_INIT, \
+       .gitmodules_done = OIDSET_INIT, \
+       .error_func = fsck_error_function \
+}
+#define FSCK_OPTIONS_STRICT { \
+       .strict = 1, \
+       .gitmodules_found = OIDSET_INIT, \
+       .gitmodules_done = OIDSET_INIT, \
+       .error_func = fsck_error_function, \
+}
+#define FSCK_OPTIONS_MISSING_GITMODULES { \
+       .strict = 1, \
+       .gitmodules_found = OIDSET_INIT, \
+       .gitmodules_done = OIDSET_INIT, \
+       .error_func = fsck_error_cb_print_missing_gitmodules, \
+}
 
 /* descend in all linked child objects
  * the return value is:
@@ -62,8 +164,6 @@ int fsck_walk(struct object *obj, void *data, struct fsck_options *options);
 int fsck_object(struct object *obj, void *data, unsigned long size,
        struct fsck_options *options);
 
-void register_found_gitmodules(const struct object_id *oid);
-
 /*
  * fsck a tag, and pass info about it back to the caller. This is
  * exposed fsck_object() internals for git-mktag(1).
@@ -109,7 +209,6 @@ const char *fsck_describe_object(struct fsck_options *options,
  * git_config() callback for use by fsck-y tools that want to support
  * fsck.<msg> fsck.skipList etc.
  */
-int fsck_config_internal(const char *var, const char *value, void *cb,
-                        struct fsck_options *options);
+int git_fsck_config(const char *var, const char *value, void *cb);
 
 #endif