doc/source/en/TortoiseGit/tgit_dug/dug_bisect.xml

   1 <?xml version="1.0" encoding="UTF-8"?>\r
   2 <!DOCTYPE sect1 SYSTEM "../../../dtd/dblite.dtd">\r
   3 <sect1 id="tgit-dug-bisect">\r
   4         <?dbhh topicname="HIDD_BISECTSTART"?>\r
   5         <title>Bisect</title>\r
   6         <indexterm>\r
   7                 <primary>Bisect</primary>\r
   8         </indexterm>\r
   9         <para>\r
  10                 If you want to find out which revision introduced a bug, you can use the bisect functionality.\r
  11                 <action>Right click</action> on a folder to pop up the context menu and then select\r
  12                 the command\r
  13                 <menuchoice>\r
  14                         <guimenu>TortoiseGit</guimenu>\r
  15                         <guimenuitem>Bisect start</guimenuitem>\r
  16                 </menuchoice>.\r
  17                 A dialog will pop up:\r
  18                 <figure id="tgit-dug-bisect-dia-1">\r
  19                         <title>Bisect start</title>\r
  20                         <graphic fileref="../images/bisect.png"/>\r
  21                 </figure>\r
  22                 Enter the last known good revision and the first or one known bad (this is normally HEAD).\r
  23         </para>\r
  24         <para>\r
  25                 After hitting <guibutton>OK</guibutton>, Git will perform a binary search for the first faulty revision: Git\r
  26                 switches to a revision in the middle. Now you can test this revision.\r
  27         </para>\r
  28         <para>\r
  29                 TortoiseGit now provides three new options in the context menu:\r
  30                 <figure id="tgit-dug-bisect-dia-2">\r
  31                         <title>Bisect options</title>\r
  32                         <graphic fileref="../images/ContextMenuBisect.png"/>\r
  33                 </figure>\r
  34                 If this revision is OK, hit\r
  35                 <menuchoice>\r
  36                         <guimenu>TortoiseGit</guimenu>\r
  37                         <guimenuitem>Bisect good</guimenuitem>\r
  38                 </menuchoice>\r
  39                 , otherwise hit\r
  40                 <menuchoice>\r
  41                         <guimenu>TortoiseGit</guimenu>\r
  42                         <guimenuitem>Bisect bad</guimenuitem>.\r
  43                 </menuchoice>\r
  44                 To skip this revision hit\r
  45                 <menuchoice>\r
  46                         <guimenu>TortoiseGit</guimenu>\r
  47                         <guimenuitem>Bisect skip</guimenuitem>.\r
  48                 </menuchoice>\r
  49                 Git will proceed with the binary search and switches to the "next" revision, so that you can test it.\r
  50                 This goes on until the faulty revision is found or you abort this operation by clicking on\r
  51                 <menuchoice>\r
  52                         <guimenu>TortoiseGit</guimenu>\r
  53                         <guimenuitem>Bisect reset</guimenuitem>\r
  54                 </menuchoice>\r
  55                 (this will reset the bisect process and switch out your previous branch/HEAD).\r
  56         </para>\r
  57         <tip>\r
  58                 <title>Selecting revisions</title>\r
  59                 <para>\r
  60                         If a revision cannot be tested, or you want to go on with a different one, you can easily go to the log and\r
  61                         (hard) reset the current HEAD to a revision you like.\r
  62                 </para>\r
  63         </tip>\r
  64         <important>\r
  65                 <title>Submodules</title>\r
  66                 <para>\r
  67                         If you use submodule you might need to make sure that those are updated after each bisect step so that all dependencies are up to date.\r
  68                 </para>\r
  69         </important>\r
  70         <para>\r
  71                 You can find more information at <xref linkend="git-bisect(1)"/>\r
  72         </para>\r
  73 </sect1>\r