Skip to content

Commit 0e25790

Browse files
chriscoolgitster
authored andcommitted
documentation: user-manual: update "using-bisect" section
Since version 1.5.6 "git bisect" doesn't use a "bisect" branch any more, but the user manual had not been updated to reflect this. So this patch does that and while at it also adds a few words about "git bisect skip" and points user to the "git bisect" man page for more information. Signed-off-by: Christian Couder <chriscool@tuxfamily.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
1 parent c4aca9c commit 0e25790

File tree

1 file changed

+21
-6
lines changed

1 file changed

+21
-6
lines changed

Documentation/user-manual.txt

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -479,10 +479,10 @@ Bisecting: 3537 revisions left to test after this
479479
-------------------------------------------------
480480

481481
If you run "git branch" at this point, you'll see that git has
482-
temporarily moved you to a new branch named "bisect". This branch
483-
points to a commit (with commit id 65934...) that is reachable from
484-
"master" but not from v2.6.18. Compile and test it, and see whether
485-
it crashes. Assume it does crash. Then:
482+
temporarily moved you in "(no branch)". HEAD is now detached from any
483+
branch and points directly to a commit (with commit id 65934...) that
484+
is reachable from "master" but not from v2.6.18. Compile and test it,
485+
and see whether it crashes. Assume it does crash. Then:
486486

487487
-------------------------------------------------
488488
$ git bisect bad
@@ -504,8 +504,7 @@ report with the commit id. Finally, run
504504
$ git bisect reset
505505
-------------------------------------------------
506506

507-
to return you to the branch you were on before and delete the
508-
temporary "bisect" branch.
507+
to return you to the branch you were on before.
509508

510509
Note that the version which git-bisect checks out for you at each
511510
point is just a suggestion, and you're free to try a different
@@ -528,6 +527,22 @@ $ git reset --hard fb47ddb2db...
528527
then test, run "bisect good" or "bisect bad" as appropriate, and
529528
continue.
530529

530+
Instead of "git bisect visualize" and then "git reset --hard
531+
fb47ddb2db...", you might just want to tell git that you want to skip
532+
the current commit:
533+
534+
-------------------------------------------------
535+
$ git bisect skip
536+
-------------------------------------------------
537+
538+
In this case, though, git may not eventually be able to tell the first
539+
bad one between some first skipped commits and a latter bad commit.
540+
541+
There are also ways to automate the bisecting process if you have a
542+
test script that can tell a good from a bad commit. See
543+
linkgit:git-bisect[1] for more information about this and other "git
544+
bisect" features.
545+
531546
[[naming-commits]]
532547
Naming commits
533548
--------------

0 commit comments

Comments
 (0)