Documentation: bisect: reformat more paragraphs.

Signed-off-by: Christian Couder <chriscool@tuxfamily.org>
Signed-off-by: Junio C Hamano <junkio@cox.net>
maint
Christian Couder 2007-03-24 06:31:49 +01:00 committed by Junio C Hamano
parent cc070d1f79
commit fed820ad56
1 changed files with 39 additions and 34 deletions

View File

@ -12,8 +12,8 @@ SYNOPSIS


DESCRIPTION DESCRIPTION
----------- -----------
The command takes various subcommands, and different options The command takes various subcommands, and different options depending
depending on the subcommand: on the subcommand:


git bisect start [<paths>...] git bisect start [<paths>...]
git bisect bad <rev> git bisect bad <rev>
@ -24,10 +24,9 @@ depending on the subcommand:
git bisect log git bisect log
git bisect run <cmd>... git bisect run <cmd>...


This command uses 'git-rev-list --bisect' option to help drive This command uses 'git-rev-list --bisect' option to help drive the
the binary search process to find which change introduced a bug, binary search process to find which change introduced a bug, given an
given an old "good" commit object name and a later "bad" commit old "good" commit object name and a later "bad" commit object name.
object name.


The way you use it is: The way you use it is:


@ -38,15 +37,16 @@ $ git bisect good v2.6.13-rc2 # v2.6.13-rc2 was the last version
# tested that was good # tested that was good
------------------------------------------------ ------------------------------------------------


When you give at least one bad and one good versions, it will When you give at least one bad and one good versions, it will bisect
bisect the revision tree and say something like: the revision tree and say something like:


------------------------------------------------ ------------------------------------------------
Bisecting: 675 revisions left to test after this Bisecting: 675 revisions left to test after this
------------------------------------------------ ------------------------------------------------


and check out the state in the middle. Now, compile that kernel, and boot and check out the state in the middle. Now, compile that kernel, and
it. Now, let's say that this booted kernel works fine, then just do boot it. Now, let's say that this booted kernel works fine, then just
do


------------------------------------------------ ------------------------------------------------
$ git bisect good # this one is good $ git bisect good # this one is good
@ -58,12 +58,12 @@ which will now say
Bisecting: 337 revisions left to test after this Bisecting: 337 revisions left to test after this
------------------------------------------------ ------------------------------------------------


and you continue along, compiling that one, testing it, and depending on and you continue along, compiling that one, testing it, and depending
whether it is good or bad, you say "git bisect good" or "git bisect bad", on whether it is good or bad, you say "git bisect good" or "git bisect
and ask for the next bisection. bad", and ask for the next bisection.


Until you have no more left, and you'll have been left with the first bad Until you have no more left, and you'll have been left with the first
kernel rev in "refs/bisect/bad". bad kernel rev in "refs/bisect/bad".


Oh, and then after you want to reset to the original head, do a Oh, and then after you want to reset to the original head, do a


@ -71,10 +71,10 @@ Oh, and then after you want to reset to the original head, do a
$ git bisect reset $ git bisect reset
------------------------------------------------ ------------------------------------------------


to get back to the master branch, instead of being in one of the bisection to get back to the master branch, instead of being in one of the
branches ("git bisect start" will do that for you too, actually: it will bisection branches ("git bisect start" will do that for you too,
reset the bisection state, and before it does that it checks that you're actually: it will reset the bisection state, and before it does that
not using some old bisection branch). it checks that you're not using some old bisection branch).


During the bisection process, you can say During the bisection process, you can say


@ -84,9 +84,14 @@ $ git bisect visualize


to see the currently remaining suspects in `gitk`. to see the currently remaining suspects in `gitk`.


The good/bad input is logged, and `git bisect The good/bad input is logged, and
log` shows what you have done so far. You can truncate its
output somewhere and save it in a file, and run ------------
$ git bisect log
------------

shows what you have done so far. You can truncate its output somewhere
and save it in a file, and run


------------ ------------
$ git bisect replay that-file $ git bisect replay that-file
@ -95,12 +100,13 @@ $ git bisect replay that-file
if you find later you made a mistake telling good/bad about a if you find later you made a mistake telling good/bad about a
revision. revision.


If in a middle of bisect session, you know what the bisect If in a middle of bisect session, you know what the bisect suggested
suggested to try next is not a good one to test (e.g. the change to try next is not a good one to test (e.g. the change the commit
the commit introduces is known not to work in your environment introduces is known not to work in your environment and you know it
and you know it does not have anything to do with the bug you does not have anything to do with the bug you are chasing), you may
are chasing), you may want to find a near-by commit and try that want to find a near-by commit and try that instead.
instead. It goes something like this:
It goes something like this:


------------ ------------
$ git bisect good/bad # previous round was good/bad. $ git bisect good/bad # previous round was good/bad.
@ -110,13 +116,12 @@ $ git reset --hard HEAD~3 # try 3 revs before what
# was suggested # was suggested
------------ ------------


Then compile and test the one you chose to try. After that, Then compile and test the one you chose to try. After that, tell
tell bisect what the result was as usual. bisect what the result was as usual.


You can further cut down the number of trials if you know what You can further cut down the number of trials if you know what part of
part of the tree is involved in the problem you are tracking the tree is involved in the problem you are tracking down, by giving
down, by giving paths parameters when you say `bisect start`, paths parameters when you say `bisect start`, like this:
like this:


------------ ------------
$ git bisect start arch/i386 include/asm-i386 $ git bisect start arch/i386 include/asm-i386