git/bisect.h
Chris Down 0cf1defa5a bisect: output state before we are ready to compute bisection
Commit 73c6de06af ("bisect: don't use invalid oid as rev when
starting") changes the behaviour of `git bisect` to consider invalid
oids as pathspecs again, as in the old shell implementation.

While that behaviour may be desirable, it can also cause confusion. For
example, while bisecting in a particular repo I encountered this:

    $ git bisect start d93ff48803f0 v6.3
    $

...which led to me sitting for a few moments, wondering why there's no
printout stating the first rev to check.

It turns out that the tag was actually "6.3", not "v6.3", and thus the
bisect was still silently started with only a bad rev, because
d93ff48803f0 was a valid oid and "v6.3" was silently considered to be a
pathspec.

While this behaviour may be desirable, it can be confusing, especially
with different repo conventions either using or not using "v" before
release names, or when a branch name or tag is simply misspelled on the
command line.

In order to avoid situations like this, make it more clear what we're
waiting for:

    $ git bisect start d93ff48803f0 v6.3
    status: waiting for good commit(s), bad commit known

We already have good output once the bisect process has begun in
earnest, so we don't need to do anything more there.

Signed-off-by: Chris Down <chris@chrisdown.name>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2022-05-11 12:35:11 -07:00

85 lines
2.4 KiB
C

#ifndef BISECT_H
#define BISECT_H
struct commit_list;
struct repository;
struct object_id;
/*
* Find bisection. If something is found, `reaches` will be the number of
* commits that the best commit reaches. `all` will be the count of
* non-SAMETREE commits. If nothing is found, `list` will be NULL.
* Otherwise, it will be either all non-SAMETREE commits or the single
* best commit, as chosen by `find_all`.
*/
void find_bisection(struct commit_list **list, int *reaches, int *all,
unsigned bisect_flags);
struct commit_list *filter_skipped(struct commit_list *list,
struct commit_list **tried,
int show_all,
int *count,
int *skipped_first);
#define BISECT_SHOW_ALL (1<<0)
#define REV_LIST_QUIET (1<<1)
#define FIND_BISECTION_ALL (1u<<0)
#define FIND_BISECTION_FIRST_PARENT_ONLY (1u<<1)
struct rev_list_info {
struct rev_info *revs;
int flags;
int show_timestamp;
int hdr_termination;
const char *header_prefix;
};
/*
* enum bisect_error represents the following return codes:
* BISECT_OK: success code. Internally, it means that next
* commit has been found (and possibly checked out) and it
* should be tested.
* BISECT_FAILED error code: default error code.
* BISECT_ONLY_SKIPPED_LEFT error code: only skipped
* commits left to be tested.
* BISECT_MERGE_BASE_CHECK error code: merge base check failed.
* BISECT_NO_TESTABLE_COMMIT error code: no testable commit found.
* BISECT_INTERNAL_SUCCESS_1ST_BAD_FOUND early success code:
* first term_bad commit found.
* BISECT_INTERNAL_SUCCESS_MERGE_BASE early success
* code: found merge base that should be tested.
* Early success codes BISECT_INTERNAL_SUCCESS_1ST_BAD_FOUND and
* BISECT_INTERNAL_SUCCESS_MERGE_BASE should be only internal codes.
*/
enum bisect_error {
BISECT_OK = 0,
BISECT_FAILED = -1,
BISECT_ONLY_SKIPPED_LEFT = -2,
BISECT_MERGE_BASE_CHECK = -3,
BISECT_NO_TESTABLE_COMMIT = -4,
BISECT_INTERNAL_SUCCESS_1ST_BAD_FOUND = -10,
BISECT_INTERNAL_SUCCESS_MERGE_BASE = -11
};
/*
* Stores how many good/bad commits we have stored for a bisect. nr_bad can
* only be 0 or 1.
*/
struct bisect_state {
unsigned int nr_good;
unsigned int nr_bad;
};
enum bisect_error bisect_next_all(struct repository *r, const char *prefix);
int estimate_bisect_steps(int all);
void read_bisect_terms(const char **bad, const char **good);
int bisect_clean_state(void);
enum bisect_error bisect_checkout(const struct object_id *bisect_rev,
int no_checkout);
#endif