stash doc: document short form -p in synopsis
[git/gitweb.git] / fsck.h
blob1e4f527318ea4b4d701a27e08d68f3551173f176
1 #ifndef GIT_FSCK_H
2 #define GIT_FSCK_H
4 #define FSCK_ERROR 1
5 #define FSCK_WARN 2
7 /*
8 * callback function for fsck_walk
9 * type is the expected type of the object or OBJ_ANY
10 * the return value is:
11 * 0 everything OK
12 * <0 error signaled and abort
13 * >0 error signaled and do not abort
15 typedef int (*fsck_walk_func)(struct object *obj, int type, void *data);
17 /* callback for fsck_object, type is FSCK_ERROR or FSCK_WARN */
18 typedef int (*fsck_error)(struct object *obj, int type, const char *err, ...);
20 __attribute__((format (printf, 3, 4)))
21 int fsck_error_function(struct object *obj, int type, const char *fmt, ...);
23 /* descend in all linked child objects
24 * the return value is:
25 * -1 error in processing the object
26 * <0 return value of the callback, which lead to an abort
27 * >0 return value of the first signaled error >0 (in the case of no other errors)
28 * 0 everything OK
30 int fsck_walk(struct object *obj, fsck_walk_func walk, void *data);
31 int fsck_object(struct object *obj, int strict, fsck_error error_func);
33 #endif