Merge branch 'cp/git-flush-is-an-env-bool'
[alt-git.git] / bisect.h
blobee3fd65f3bdb89611d7575239ee79e8c50bcd703
1 #ifndef BISECT_H
2 #define BISECT_H
4 struct commit_list;
5 struct repository;
6 struct object_id;
8 /*
9 * Find bisection. If something is found, `reaches` will be the number of
10 * commits that the best commit reaches. `all` will be the count of
11 * non-SAMETREE commits. If nothing is found, `list` will be NULL.
12 * Otherwise, it will be either all non-SAMETREE commits or the single
13 * best commit, as chosen by `find_all`.
15 void find_bisection(struct commit_list **list, int *reaches, int *all,
16 unsigned bisect_flags);
18 struct commit_list *filter_skipped(struct commit_list *list,
19 struct commit_list **tried,
20 int show_all,
21 int *count,
22 int *skipped_first);
24 #define BISECT_SHOW_ALL (1<<0)
25 #define REV_LIST_QUIET (1<<1)
27 #define FIND_BISECTION_ALL (1u<<0)
28 #define FIND_BISECTION_FIRST_PARENT_ONLY (1u<<1)
30 struct rev_list_info {
31 struct rev_info *revs;
32 int flags;
33 int show_timestamp;
34 int hdr_termination;
35 const char *header_prefix;
39 * enum bisect_error represents the following return codes:
40 * BISECT_OK: success code. Internally, it means that next
41 * commit has been found (and possibly checked out) and it
42 * should be tested.
43 * BISECT_FAILED error code: default error code.
44 * BISECT_ONLY_SKIPPED_LEFT error code: only skipped
45 * commits left to be tested.
46 * BISECT_MERGE_BASE_CHECK error code: merge base check failed.
47 * BISECT_NO_TESTABLE_COMMIT error code: no testable commit found.
48 * BISECT_INTERNAL_SUCCESS_1ST_BAD_FOUND early success code:
49 * first term_bad commit found.
50 * BISECT_INTERNAL_SUCCESS_MERGE_BASE early success
51 * code: found merge base that should be tested.
52 * Early success codes BISECT_INTERNAL_SUCCESS_1ST_BAD_FOUND and
53 * BISECT_INTERNAL_SUCCESS_MERGE_BASE should be only internal codes.
55 enum bisect_error {
56 BISECT_OK = 0,
57 BISECT_FAILED = -1,
58 BISECT_ONLY_SKIPPED_LEFT = -2,
59 BISECT_MERGE_BASE_CHECK = -3,
60 BISECT_NO_TESTABLE_COMMIT = -4,
61 BISECT_INTERNAL_SUCCESS_1ST_BAD_FOUND = -10,
62 BISECT_INTERNAL_SUCCESS_MERGE_BASE = -11
66 * Stores how many good/bad commits we have stored for a bisect. nr_bad can
67 * only be 0 or 1.
69 struct bisect_state {
70 unsigned int nr_good;
71 unsigned int nr_bad;
74 enum bisect_error bisect_next_all(struct repository *r, const char *prefix);
76 int estimate_bisect_steps(int all);
78 void read_bisect_terms(const char **bad, const char **good);
80 int bisect_clean_state(void);
82 enum bisect_error bisect_checkout(const struct object_id *bisect_rev,
83 int no_checkout);
85 #endif