updated git doc

[TortoiseGit.git] / doc / source / en / TortoiseGit / git_doc / git-bisect.xml

<?xml version="1.0" encoding="UTF-8"?>\r
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">\r
\r
<article lang="en" id="git-bisect(1)">\r
<articleinfo>\r
    <title>git-bisect(1)</title>\r
<indexterm>\r
<primary>git-bisect(1)</primary>\r
</indexterm>\r
</articleinfo>\r
<simplesect id="_name">\r
<title>NAME</title>\r
<simpara>git-bisect - Find by binary search the change that introduced a bug</simpara>\r
</simplesect>\r
<simplesect id="_synopsis">\r
<title>SYNOPSIS</title>\r
<blockquote>\r
<literallayout><emphasis>git bisect</emphasis> &lt;subcommand&gt; &lt;options&gt;</literallayout>\r
</blockquote>\r
</simplesect>\r
<simplesect id="_description">\r
<title>DESCRIPTION</title>\r
<simpara>The command takes various subcommands, and different options depending\r
on the subcommand:</simpara>\r
<literallayout class="monospaced">git bisect help\r
git bisect start [--no-checkout] [&lt;bad&gt; [&lt;good&gt;...]] [--] [&lt;paths&gt;...]\r
git bisect bad [&lt;rev&gt;]\r
git bisect good [&lt;rev&gt;...]\r
git bisect skip [(&lt;rev&gt;|&lt;range&gt;)...]\r
git bisect reset [&lt;commit&gt;]\r
git bisect visualize\r
git bisect replay &lt;logfile&gt;\r
git bisect log\r
git bisect run &lt;cmd&gt;...</literallayout>\r
<simpara>This command uses <emphasis>git rev-list --bisect</emphasis> to help drive the\r
binary search process to find which change introduced a bug, given an\r
old "good" commit object name and a later "bad" commit object name.</simpara>\r
<section id="_getting_help">\r
<title>Getting help</title>\r
<simpara>Use "git bisect" to get a short usage description, and "git bisect\r
help" or "git bisect -h" to get a long usage description.</simpara>\r
</section>\r
<section id="_basic_bisect_commands_start_bad_good">\r
<title>Basic bisect commands: start, bad, good</title>\r
<simpara>Using the Linux kernel tree as an example, basic use of the bisect\r
command is as follows:</simpara>\r
<screen>$ git bisect start\r
$ git bisect bad                 # Current version is bad\r
$ git bisect good v2.6.13-rc2    # v2.6.13-rc2 was the last version\r
                                 # tested that was good</screen>\r
<simpara>When you have specified at least one bad and one good version, the\r
command bisects the revision tree and outputs something similar to\r
the following:</simpara>\r
<screen>Bisecting: 675 revisions left to test after this</screen>\r
<simpara>The state in the middle of the set of revisions is then checked out.\r
You would now compile that kernel and boot it. If the booted kernel\r
works correctly, you would then issue the following command:</simpara>\r
<screen>$ git bisect good                       # this one is good</screen>\r
<simpara>The output of this command would be something similar to the following:</simpara>\r
<screen>Bisecting: 337 revisions left to test after this</screen>\r
<simpara>You keep repeating this process, compiling the tree, testing it, and\r
depending on whether it is good or bad issuing the command "git bisect good"\r
or "git bisect bad" to ask for the next bisection.</simpara>\r
<simpara>Eventually there will be no more revisions left to bisect, and you\r
will have been left with the first bad kernel revision in "refs/bisect/bad".</simpara>\r
</section>\r
<section id="_bisect_reset">\r
<title>Bisect reset</title>\r
<simpara>After a bisect session, to clean up the bisection state and return to\r
the original HEAD, issue the following command:</simpara>\r
<screen>$ git bisect reset</screen>\r
<simpara>By default, this will return your tree to the commit that was checked\r
out before <emphasis>git bisect start</emphasis>.  (A new <emphasis>git bisect start</emphasis> will also do\r
that, as it cleans up the old bisection state.)</simpara>\r
<simpara>With an optional argument, you can return to a different commit\r
instead:</simpara>\r
<screen>$ git bisect reset &lt;commit&gt;</screen>\r
<simpara>For example, <emphasis>git bisect reset HEAD</emphasis> will leave you on the current\r
bisection commit and avoid switching commits at all, while <emphasis>git bisect\r
reset bisect/bad</emphasis> will check out the first bad revision.</simpara>\r
</section>\r
<section id="_bisect_visualize">\r
<title>Bisect visualize</title>\r
<simpara>To see the currently remaining suspects in <emphasis>gitk</emphasis>, issue the following\r
command during the bisection process:</simpara>\r
<screen>$ git bisect visualize</screen>\r
<simpara><emphasis>view</emphasis> may also be used as a synonym for <emphasis>visualize</emphasis>.</simpara>\r
<simpara>If the <emphasis>DISPLAY</emphasis> environment variable is not set, <emphasis>git log</emphasis> is used\r
instead.  You can also give command line options such as <emphasis>-p</emphasis> and\r
<emphasis>--stat</emphasis>.</simpara>\r
<screen>$ git bisect view --stat</screen>\r
</section>\r
<section id="_bisect_log_and_bisect_replay">\r
<title>Bisect log and bisect replay</title>\r
<simpara>After having marked revisions as good or bad, issue the following\r
command to show what has been done so far:</simpara>\r
<screen>$ git bisect log</screen>\r
<simpara>If you discover that you made a mistake in specifying the status of a\r
revision, you can save the output of this command to a file, edit it to\r
remove the incorrect entries, and then issue the following commands to\r
return to a corrected state:</simpara>\r
<screen>$ git bisect reset\r
$ git bisect replay that-file</screen>\r
</section>\r
<section id="_avoiding_testing_a_commit">\r
<title>Avoiding testing a commit</title>\r
<simpara>If, in the middle of a bisect session, you know that the next suggested\r
revision is not a good one to test (e.g. the change the commit\r
introduces is known not to work in your environment and you know it\r
does not have anything to do with the bug you are chasing), you may\r
want to find a nearby commit and try that instead.</simpara>\r
<simpara>For example:</simpara>\r
<screen>$ git bisect good/bad                   # previous round was good or bad.\r
Bisecting: 337 revisions left to test after this\r
$ git bisect visualize                  # oops, that is uninteresting.\r
$ git reset --hard HEAD~3               # try 3 revisions before what\r
                                        # was suggested</screen>\r
<simpara>Then compile and test the chosen revision, and afterwards mark\r
the revision as good or bad in the usual manner.</simpara>\r
</section>\r
<section id="_bisect_skip">\r
<title>Bisect skip</title>\r
<simpara>Instead of choosing by yourself a nearby commit, you can ask git\r
to do it for you by issuing the command:</simpara>\r
<screen>$ git bisect skip                 # Current version cannot be tested</screen>\r
<simpara>But git may eventually be unable to tell the first bad commit among\r
a bad commit and one or more skipped commits.</simpara>\r
<simpara>You can even skip a range of commits, instead of just one commit,\r
using the "<emphasis>&lt;commit1&gt;</emphasis>..<emphasis>&lt;commit2&gt;</emphasis>" notation. For example:</simpara>\r
<screen>$ git bisect skip v2.5..v2.6</screen>\r
<simpara>This tells the bisect process that no commit after <emphasis>v2.5</emphasis>, up to and\r
including <emphasis>v2.6</emphasis>, should be tested.</simpara>\r
<simpara>Note that if you also want to skip the first commit of the range you\r
would issue the command:</simpara>\r
<screen>$ git bisect skip v2.5 v2.5..v2.6</screen>\r
<simpara>This tells the bisect process that the commits between <emphasis>v2.5</emphasis> included\r
and <emphasis>v2.6</emphasis> included should be skipped.</simpara>\r
</section>\r
<section id="_cutting_down_bisection_by_giving_more_parameters_to_bisect_start">\r
<title>Cutting down bisection by giving more parameters to bisect start</title>\r
<simpara>You can further cut down the number of trials, if you know what part of\r
the tree is involved in the problem you are tracking down, by specifying\r
path parameters when issuing the <emphasis>bisect start</emphasis> command:</simpara>\r
<screen>$ git bisect start -- arch/i386 include/asm-i386</screen>\r
<simpara>If you know beforehand more than one good commit, you can narrow the\r
bisect space down by specifying all of the good commits immediately after\r
the bad commit when issuing the <emphasis>bisect start</emphasis> command:</simpara>\r
<screen>$ git bisect start v2.6.20-rc6 v2.6.20-rc4 v2.6.20-rc1 --\r
                   # v2.6.20-rc6 is bad\r
                   # v2.6.20-rc4 and v2.6.20-rc1 are good</screen>\r
</section>\r
<section id="_bisect_run">\r
<title>Bisect run</title>\r
<simpara>If you have a script that can tell if the current source code is good\r
or bad, you can bisect by issuing the command:</simpara>\r
<screen>$ git bisect run my_script arguments</screen>\r
<simpara>Note that the script (<emphasis>my_script</emphasis> in the above example) should\r
exit with code 0 if the current source code is good, and exit with a\r
code between 1 and 127 (inclusive), except 125, if the current\r
source code is bad.</simpara>\r
<simpara>Any other exit code will abort the bisect process. It should be noted\r
that a program that terminates via "exit(-1)" leaves $? = 255, (see the\r
exit(3) manual page), as the value is chopped with "&amp; 0377".</simpara>\r
<simpara>The special exit code 125 should be used when the current source code\r
cannot be tested. If the script exits with this code, the current\r
revision will be skipped (see <emphasis>git bisect skip</emphasis> above). 125 was chosen\r
as the highest sensible value to use for this purpose, because 126 and 127\r
are used by POSIX shells to signal specific error status (127 is for\r
command not found, 126 is for command found but not executable---these\r
details do not matter, as they are normal errors in the script, as far as\r
"bisect run" is concerned).</simpara>\r
<simpara>You may often find that during a bisect session you want to have\r
temporary modifications (e.g. s/#define DEBUG 0/#define DEBUG 1/ in a\r
header file, or "revision that does not have this commit needs this\r
patch applied to work around another problem this bisection is not\r
interested in") applied to the revision being tested.</simpara>\r
<simpara>To cope with such a situation, after the inner <emphasis>git bisect</emphasis> finds the\r
next revision to test, the script can apply the patch\r
before compiling, run the real test, and afterwards decide if the\r
revision (possibly with the needed patch) passed the test and then\r
rewind the tree to the pristine state.  Finally the script should exit\r
with the status of the real test to let the "git bisect run" command loop\r
determine the eventual outcome of the bisect session.</simpara>\r
</section>\r
</simplesect>\r
<simplesect id="_options">\r
<title>OPTIONS</title>\r
<variablelist>\r
<varlistentry>\r
<term>\r
--no-checkout\r
</term>\r
<listitem>\r
<simpara>Do not checkout the new working tree at each iteration of the bisection\r
process. Instead just update a special reference named <emphasis>BISECT_HEAD</emphasis> to make\r
it point to the commit that should be tested.</simpara>\r
<simpara>This option may be useful when the test you would perform in each step\r
does not require a checked out tree.</simpara>\r
<simpara>If the repository is bare, <emphasis>--no-checkout</emphasis> is assumed.</simpara>\r
</listitem>\r
</varlistentry>\r
</variablelist>\r
</simplesect>\r
<simplesect id="_examples">\r
<title>EXAMPLES</title>\r
<itemizedlist>\r
<listitem>\r
<simpara>\r
Automatically bisect a broken build between v1.2 and HEAD:\r
</simpara>\r
<screen>$ git bisect start HEAD v1.2 --      # HEAD is bad, v1.2 is good\r
$ git bisect run make                # "make" builds the app</screen>\r
</listitem>\r
<listitem>\r
<simpara>\r
Automatically bisect a test failure between origin and HEAD:\r
</simpara>\r
<screen>$ git bisect start HEAD origin --    # HEAD is bad, origin is good\r
$ git bisect run make test           # "make test" builds and tests</screen>\r
</listitem>\r
<listitem>\r
<simpara>\r
Automatically bisect a broken test case:\r
</simpara>\r
<screen>$ cat ~/test.sh\r
#!/bin/sh\r
make || exit 125                     # this skips broken builds\r
~/check_test_case.sh                 # does the test case pass?\r
$ git bisect start HEAD HEAD~10 --   # culprit is among the last 10\r
$ git bisect run ~/test.sh</screen>\r
<simpara>Here we use a "test.sh" custom script. In this script, if "make"\r
fails, we skip the current commit.\r
"check_test_case.sh" should "exit 0" if the test case passes,\r
and "exit 1" otherwise.</simpara>\r
<simpara>It is safer if both "test.sh" and "check_test_case.sh" are\r
outside the repository to prevent interactions between the bisect,\r
make and test processes and the scripts.</simpara>\r
</listitem>\r
<listitem>\r
<simpara>\r
Automatically bisect with temporary modifications (hot-fix):\r
</simpara>\r
<screen>$ cat ~/test.sh\r
#!/bin/sh\r
\r
# tweak the working tree by merging the hot-fix branch\r
# and then attempt a build\r
if      git merge --no-commit hot-fix &amp;&amp;\r
        make\r
then\r
        # run project specific test and report its status\r
        ~/check_test_case.sh\r
        status=$?\r
else\r
        # tell the caller this is untestable\r
        status=125\r
fi\r
\r
# undo the tweak to allow clean flipping to the next commit\r
git reset --hard\r
\r
# return control\r
exit $status</screen>\r
<simpara>This applies modifications from a hot-fix branch before each test run,\r
e.g. in case your build or test environment changed so that older\r
revisions may need a fix which newer ones have already. (Make sure the\r
hot-fix branch is based off a commit which is contained in all revisions\r
which you are bisecting, so that the merge does not pull in too much, or\r
use <emphasis>git cherry-pick</emphasis> instead of <emphasis>git merge</emphasis>.)</simpara>\r
</listitem>\r
<listitem>\r
<simpara>\r
Automatically bisect a broken test case:\r
</simpara>\r
<screen>$ git bisect start HEAD HEAD~10 --   # culprit is among the last 10\r
$ git bisect run sh -c "make || exit 125; ~/check_test_case.sh"</screen>\r
<simpara>This shows that you can do without a run script if you write the test\r
on a single line.</simpara>\r
</listitem>\r
<listitem>\r
<simpara>\r
Locate a good region of the object graph in a damaged repository\r
</simpara>\r
<screen>$ git bisect start HEAD &lt;known-good-commit&gt; [ &lt;boundary-commit&gt; ... ] --no-checkout\r
$ git bisect run sh -c '\r
        GOOD=$(git for-each-ref "--format=%(objectname)" refs/bisect/good-*) &amp;&amp;\r
        git rev-list --objects BISECT_HEAD --not $GOOD &gt;tmp.$$ &amp;&amp;\r
        git pack-objects --stdout &gt;/dev/null &lt;tmp.$$\r
        rc=$?\r
        rm -f tmp.$$\r
        test $rc = 0'</screen>\r
<simpara>In this case, when <emphasis>git bisect run</emphasis> finishes, bisect/bad will refer to a commit that\r
has at least one parent whose reachable graph is fully traversable in the sense\r
required by <emphasis>git pack objects</emphasis>.</simpara>\r
</listitem>\r
</itemizedlist>\r
</simplesect>\r
<simplesect id="_see_also">\r
<title>SEE ALSO</title>\r
<simpara>link:git-bisect-lk2009.html[Fighting regressions with git bisect],\r
<xref linkend="git-blame(1)" />.</simpara>\r
</simplesect>\r
<simplesect id="_git">\r
<title>GIT</title>\r
<simpara>Part of the <xref linkend="git(1)" /> suite</simpara>\r
</simplesect>\r
</article>\r