docs: add documentation for extensions.objectFormat
[git.git] / bisect.h
blob8bad8d8391546f347ec91324eca21f74bda8e68f
1 #ifndef BISECT_H
2 #define BISECT_H
4 struct commit_list;
5 struct repository;
7 /*
8 * Find bisection. If something is found, `reaches` will be the number of
9 * commits that the best commit reaches. `all` will be the count of
10 * non-SAMETREE commits. If nothing is found, `list` will be NULL.
11 * Otherwise, it will be either all non-SAMETREE commits or the single
12 * best commit, as chosen by `find_all`.
14 void find_bisection(struct commit_list **list, int *reaches, int *all,
15 int find_all);
17 struct commit_list *filter_skipped(struct commit_list *list,
18 struct commit_list **tried,
19 int show_all,
20 int *count,
21 int *skipped_first);
23 #define BISECT_SHOW_ALL (1<<0)
24 #define REV_LIST_QUIET (1<<1)
26 struct rev_list_info {
27 struct rev_info *revs;
28 int flags;
29 int show_timestamp;
30 int hdr_termination;
31 const char *header_prefix;
35 * enum bisect_error represents the following return codes:
36 * BISECT_OK: success code. Internally, it means that next
37 * commit has been found (and possibly checked out) and it
38 * should be tested.
39 * BISECT_FAILED error code: default error code.
40 * BISECT_ONLY_SKIPPED_LEFT error code: only skipped
41 * commits left to be tested.
42 * BISECT_MERGE_BASE_CHECK error code: merge base check failed.
43 * BISECT_NO_TESTABLE_COMMIT error code: no testable commit found.
44 * BISECT_INTERNAL_SUCCESS_1ST_BAD_FOUND early success code:
45 * first term_bad commit found.
46 * BISECT_INTERNAL_SUCCESS_MERGE_BASE early success
47 * code: found merge base that should be tested.
48 * Early success codes BISECT_INTERNAL_SUCCESS_1ST_BAD_FOUND and
49 * BISECT_INTERNAL_SUCCESS_MERGE_BASE should be only internal codes.
51 enum bisect_error {
52 BISECT_OK = 0,
53 BISECT_FAILED = -1,
54 BISECT_ONLY_SKIPPED_LEFT = -2,
55 BISECT_MERGE_BASE_CHECK = -3,
56 BISECT_NO_TESTABLE_COMMIT = -4,
57 BISECT_INTERNAL_SUCCESS_1ST_BAD_FOUND = -10,
58 BISECT_INTERNAL_SUCCESS_MERGE_BASE = -11
61 enum bisect_error bisect_next_all(struct repository *r,
62 const char *prefix,
63 int no_checkout);
65 int estimate_bisect_steps(int all);
67 void read_bisect_terms(const char **bad, const char **good);
69 int bisect_clean_state(void);
71 #endif