Autogenerated HTML docs for v1.5.1-rc1-51-gb08b

1 files changed, 57 insertions, 47 deletions

diff --git a/git-bisect.html b/git-bisect.html
index 3353ef6bd..ec5ac0ea7 100644
--- a/git-bisect.html
+++ b/git-bisect.html
@@ -276,8 +276,8 @@ git-bisect(1) Manual Page
 </div>

 <h2>DESCRIPTION</h2>

 <div class="sectionbody">

-<p>The command takes various subcommands, and different options

-depending on the subcommand:</p>

+<p>The command takes various subcommands, and different options depending

+on the subcommand:</p>

 <div class="literalblock">

 <div class="content">

 <pre><tt>git bisect start [&lt;paths&gt;...]

@@ -289,26 +289,27 @@ git bisect replay &lt;logfile&gt;
 git bisect log

 git bisect run &lt;cmd&gt;...</tt></pre>

 </div></div>

-<p>This command uses <em>git-rev-list --bisect</em> option to help drive

-the binary search process to find which change introduced a bug,

-given an old "good" commit object name and a later "bad" commit

-object name.</p>

+<p>This command uses <em>git-rev-list --bisect</em> option to help drive the

+binary search process to find which change introduced a bug, given an

+old "good" commit object name and a later "bad" commit object name.</p>

+<h3>Basic bisect commands: start, bad, good</h3>

 <p>The way you use it is:</p>

 <div class="listingblock">

 <div class="content">

 <pre><tt>$ git bisect start

-$ git bisect bad                        # Current version is bad

-$ git bisect good v2.6.13-rc2           # v2.6.13-rc2 was the last version

-                                        # tested that was good</tt></pre>

+$ git bisect bad                 # Current version is bad

+$ git bisect good v2.6.13-rc2    # v2.6.13-rc2 was the last version

+                                 # tested that was good</tt></pre>

 </div></div>

-<p>When you give at least one bad and one good versions, it will

-bisect the revision tree and say something like:</p>

+<p>When you give at least one bad and one good versions, it will bisect

+the revision tree and say something like:</p>

 <div class="listingblock">

 <div class="content">

 <pre><tt>Bisecting: 675 revisions left to test after this</tt></pre>

 </div></div>

-<p>and check out the state in the middle. Now, compile that kernel, and boot

-it. Now, let's say that this booted kernel works fine, then just do</p>

+<p>and check out the state in the middle. Now, compile that kernel, and

+boot it. Now, let's say that this booted kernel works fine, then just

+do</p>

 <div class="listingblock">

 <div class="content">

 <pre><tt>$ git bisect good                       # this one is good</tt></pre>

@@ -318,41 +319,49 @@ it. Now, let's say that this booted kernel works fine, then just do</p>
 <div class="content">

 <pre><tt>Bisecting: 337 revisions left to test after this</tt></pre>

 </div></div>

-<p>and you continue along, compiling that one, testing it, and depending on

-whether it is good or bad, you say "git bisect good" or "git bisect bad",

-and ask for the next bisection.</p>

-<p>Until you have no more left, and you'll have been left with the first bad

-kernel rev in "refs/bisect/bad".</p>

+<p>and you continue along, compiling that one, testing it, and depending

+on whether it is good or bad, you say "git bisect good" or "git bisect

+bad", and ask for the next bisection.</p>

+<p>Until you have no more left, and you'll have been left with the first

+bad kernel rev in "refs/bisect/bad".</p>

+<h3>Bisect reset</h3>

 <p>Oh, and then after you want to reset to the original head, do a</p>

 <div class="listingblock">

 <div class="content">

 <pre><tt>$ git bisect reset</tt></pre>

 </div></div>

-<p>to get back to the master branch, instead of being in one of the bisection

-branches ("git bisect start" will do that for you too, actually: it will

-reset the bisection state, and before it does that it checks that you're

-not using some old bisection branch).</p>

+<p>to get back to the master branch, instead of being in one of the

+bisection branches ("git bisect start" will do that for you too,

+actually: it will reset the bisection state, and before it does that

+it checks that you're not using some old bisection branch).</p>

+<h3>Bisect visualize</h3>

 <p>During the bisection process, you can say</p>

 <div class="listingblock">

 <div class="content">

 <pre><tt>$ git bisect visualize</tt></pre>

 </div></div>

 <p>to see the currently remaining suspects in <tt>gitk</tt>.</p>

-<p>The good/bad input is logged, and <tt>git bisect

-log</tt> shows what you have done so far.  You can truncate its

-output somewhere and save it in a file, and run</p>

+<h3>Bisect log and bisect replay</h3>

+<p>The good/bad input is logged, and</p>

+<div class="listingblock">

+<div class="content">

+<pre><tt>$ git bisect log</tt></pre>

+</div></div>

+<p>shows what you have done so far. You can truncate its output somewhere

+and save it in a file, and run</p>

 <div class="listingblock">

 <div class="content">

 <pre><tt>$ git bisect replay that-file</tt></pre>

 </div></div>

 <p>if you find later you made a mistake telling good/bad about a

 revision.</p>

-<p>If in a middle of bisect session, you know what the bisect

-suggested to try next is not a good one to test (e.g. the change

-the commit introduces is known not to work in your environment

-and you know it does not have anything to do with the bug you

-are chasing), you may want to find a near-by commit and try that

-instead.  It goes something like this:</p>

+<h3>Avoiding to test a commit</h3>

+<p>If in a middle of bisect session, you know what the bisect suggested

+to try next is not a good one to test (e.g. the change the commit

+introduces is known not to work in your environment and you know it

+does not have anything to do with the bug you are chasing), you may

+want to find a near-by commit and try that instead.</p>

+<p>It goes something like this:</p>

 <div class="listingblock">

 <div class="content">

 <pre><tt>$ git bisect good/bad                   # previous round was good/bad.

@@ -361,29 +370,30 @@ $ git bisect visualize                  # oops, that is uninteresting.
 $ git reset --hard HEAD~3               # try 3 revs before what

                                         # was suggested</tt></pre>

 </div></div>

-<p>Then compile and test the one you chose to try.  After that,

-tell bisect what the result was as usual.</p>

-<p>You can further cut down the number of trials if you know what

-part of the tree is involved in the problem you are tracking

-down, by giving paths parameters when you say <tt>bisect start</tt>,

-like this:</p>

+<p>Then compile and test the one you chose to try. After that, tell

+bisect what the result was as usual.</p>

+<h3>Cutting down bisection by giving path parameter to bisect start</h3>

+<p>You can further cut down the number of trials if you know what part of

+the tree is involved in the problem you are tracking down, by giving

+paths parameters when you say <tt>bisect start</tt>, like this:</p>

 <div class="listingblock">

 <div class="content">

 <pre><tt>$ git bisect start arch/i386 include/asm-i386</tt></pre>

 </div></div>

-<p>If you have a script that can tell if the current

-source code is good or bad, you can automatically bisect using:</p>

+<h3>Bisect run</h3>

+<p>If you have a script that can tell if the current source code is good

+or bad, you can automatically bisect using:</p>

 <div class="listingblock">

 <div class="content">

 <pre><tt>$ git bisect run my_script</tt></pre>

 </div></div>

-<p>Note that the "run" script (<tt>my_script</tt> in the above example)

-should exit with code 0 in

-case the current source code is good and with a code between 1 and 127

-(included) in case the current source code is bad.</p>

-<p>Any other exit code (a program that does "exit(-1)" leaves $? = 255,

-see exit(3) manual page, the value is chopped with "&amp; 0377") will

-abort the automatic bisect process.</p>

+<p>Note that the "run" script (<tt>my_script</tt> in the above example) should

+exit with code 0 in case the current source code is good and with a

+code between 1 and 127 (included) in case the current source code is

+bad.</p>

+<p>Any other exit code will abort the automatic bisect process. (A

+program that does "exit(-1)" leaves $? = 255, see exit(3) manual page,

+the value is chopped with "&amp; 0377".)</p>

 <p>You may often find that during bisect you want to have near-constant

 tweaks (e.g., s/#define DEBUG 0/#define DEBUG 1/ in a header file, or

 "revision that does not have this commit needs this patch applied to

@@ -411,7 +421,7 @@ know the outcome.</p>
 </div>

 <div id="footer">

 <div id="footer-text">

-Last updated 23-Mar-2007 10:46:02 UTC

+Last updated 24-Mar-2007 07:16:24 UTC

 </div>

 </div>

 </body>