Git 2.32
[git] / bisect.h
1 #ifndef BISECT_H
2 #define BISECT_H
3
4 struct commit_list;
5 struct repository;
6
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`.
13  */
14 void find_bisection(struct commit_list **list, int *reaches, int *all,
15                     unsigned bisect_flags);
16
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);
22
23 #define BISECT_SHOW_ALL         (1<<0)
24 #define REV_LIST_QUIET          (1<<1)
25
26 #define FIND_BISECTION_ALL                      (1u<<0)
27 #define FIND_BISECTION_FIRST_PARENT_ONLY        (1u<<1)
28
29 struct rev_list_info {
30         struct rev_info *revs;
31         int flags;
32         int show_timestamp;
33         int hdr_termination;
34         const char *header_prefix;
35 };
36
37 /*
38  * enum bisect_error represents the following return codes:
39  * BISECT_OK: success code. Internally, it means that next
40  * commit has been found (and possibly checked out) and it
41  * should be tested.
42  * BISECT_FAILED error code: default error code.
43  * BISECT_ONLY_SKIPPED_LEFT error code: only skipped
44  * commits left to be tested.
45  * BISECT_MERGE_BASE_CHECK error code: merge base check failed.
46  * BISECT_NO_TESTABLE_COMMIT error code: no testable commit found.
47  * BISECT_INTERNAL_SUCCESS_1ST_BAD_FOUND early success code:
48  * first term_bad commit found.
49  * BISECT_INTERNAL_SUCCESS_MERGE_BASE early success
50  * code: found merge base that should be tested.
51  * Early success codes BISECT_INTERNAL_SUCCESS_1ST_BAD_FOUND and
52  * BISECT_INTERNAL_SUCCESS_MERGE_BASE should be only internal codes.
53  */
54 enum bisect_error {
55         BISECT_OK = 0,
56         BISECT_FAILED = -1,
57         BISECT_ONLY_SKIPPED_LEFT = -2,
58         BISECT_MERGE_BASE_CHECK = -3,
59         BISECT_NO_TESTABLE_COMMIT = -4,
60         BISECT_INTERNAL_SUCCESS_1ST_BAD_FOUND = -10,
61         BISECT_INTERNAL_SUCCESS_MERGE_BASE = -11
62 };
63
64 enum bisect_error bisect_next_all(struct repository *r, const char *prefix);
65
66 int estimate_bisect_steps(int all);
67
68 void read_bisect_terms(const char **bad, const char **good);
69
70 int bisect_clean_state(void);
71
72 #endif