Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

git-bisect: add page #1227

Merged
merged 3 commits into from
Jan 7, 2017
Merged

git-bisect: add page #1227

merged 3 commits into from
Jan 7, 2017

Conversation

waldyrious
Copy link
Member

No description provided.

@waldyrious waldyrious added the new command Issues requesting creation of a new page or PRs adding a new page for a command. label Jan 4, 2017

`git bisect reset`

- Skip a commit during a bisect (e.g. one that causes a broken build due to another issue):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did not get this. Why would you need to skip a commit ? If its unrelated to the current bug, we can just mark it as good right ?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If a commit is broken for a different reason, you may not be able to tell whether the issue you're looking for is present in it or not -- the idea here is to tell git bisect to ignore this commit rather than pass it as a data point, as that could be a false positive or a false negative, both of which would pollute the binary search process.

> Use binary search to find the commit that introduced a bug.
> Git automatically jumps back and forth in the commit graph to progressively narrow down the faulty commit.

- Start a bisect section by passing a known good commit and a known bad commit:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was slightly stumped in understanding "known bad commit". How can I know the bad commit if I have to find it in the first place ? Then it dawned on me, that its a commit sufficiently back in time so that the actual commit which introduced the bug is in the range.

Maybe we can rephrase it as - "Start a bisect section by passing a start and end commit which contains the commit we want to find".

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that makes sense. Will change.

ps - I just realized I meant to write "Start a bisect session", not "section"! Will fix that as well.

@waldyrious
Copy link
Member Author

@agnivade I went through a lot of back-and-forth attempting to produce concise yet clear descriptions. I'm not sure I managed it; PTAL.

@agnivade
Copy link
Member

agnivade commented Jan 6, 2017

Nicely done. 👍

@waldyrious waldyrious merged commit 57c2940 into master Jan 7, 2017
@waldyrious waldyrious deleted the git-bisect branch January 7, 2017 01:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new command Issues requesting creation of a new page or PRs adding a new page for a command.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants