Merge pull request #192 from UCL/clean_bisect

Updates git bisect instructions to make them more readable

Author: dpshelio

ch02git/14Bisect.ipynb

@@ -62,7 +62,7 @@
    "source": [
     "%%bash\n",
     "rm -rf bisectdemo\n",
-    "git clone [email protected]:shawnsi/bisectdemo.git"
+    "git clone [email protected]:UCL-RITS/bisectdemo.git"
    ]
   },
   {
@@ -137,13 +137,12 @@
      "name": "stderr",
      "output_type": "stream",
      "text": [
-      "error: branch 'buggy' not found.\n",
       "Switched to a new branch 'buggy'\n"
      ]
     }
    ],
    "source": [
-    "%%bash \n",
+    "%%bash\n",
     "./breakme.sh > break_output"
    ]
   },
@@ -165,15 +164,28 @@
    },
    "outputs": [
     {
-     "ename": "SyntaxError",
-     "evalue": "invalid syntax (<ipython-input-6-69f578907137>, line 1)",
+     "name": "stderr",
+     "output_type": "stream",
+     "text": [
+      "Traceback (most recent call last):\n",
+      "  File \"squares.py\", line 9, in <module>\n",
+      "    print(integer**2)\n",
+      "TypeError: unsupported operand type(s) for ** or pow(): 'str' and 'int'\n"
+     ]
+    },
+    {
+     "ename": "CalledProcessError",
+     "evalue": "Command 'b'python squares.py 2 #\\xc2\\xa0Error message\\n'' returned non-zero exit status 1.",
      "output_type": "error",
      "traceback": [
-      "\u001b[0;36m  File \u001b[0;32m\"<ipython-input-6-69f578907137>\"\u001b[0;36m, line \u001b[0;32m1\u001b[0m\n\u001b[0;31m    python squares.py 2 # Error message\u001b[0m\n\u001b[0m                 ^\u001b[0m\n\u001b[0;31mSyntaxError\u001b[0m\u001b[0;31m:\u001b[0m invalid syntax\n"
+      "\u001b[0;31m---------------------------------------------------------------------------\u001b[0m",
+      "\u001b[0;31mCalledProcessError\u001b[0m                        Traceback (most recent call last)",
+      "\u001b[0;31mCalledProcessError\u001b[0m: Command 'b'python squares.py 2 #\\xc2\\xa0Error message\\n'' returned non-zero exit status 1."
      ]
     }
    ],
    "source": [
+    "%%bash\n",
     "python squares.py 2 # Error message"
    ]
   },
@@ -316,8 +328,10 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
+    "Stop the bisect process with:\n",
+    "\n",
     "``` bash\n",
-    "git bisect end\n",
+    "git bisect reset\n",
     "```"
    ]
   },
@@ -327,7 +341,9 @@
    "source": [
     "### Solving automatically\n",
     "\n",
-    "If we have an appropriate unit test, we can do all this automatically:"
+    "If we have an appropriate unit test, we can do all this automatically:\n",
+    "\n",
+    "(*NOTE*: You don't need [to redirect the `stderr` and `stdout`](https://linuxize.com/post/bash-redirect-stderr-stdout/) (with `&>`) of `git bisect run` to a file when running these commands outside a jupyter notebook (i.e., on a shell). This is done here so the errors appears with the right commits)"
    ]
   },
   {
@@ -351,77 +367,72 @@
      "output_type": "stream",
      "text": [
       "Bisecting: 500 revisions left to test after this (roughly 9 steps)\n",
-      "[f85561dbe54b69fc7f037e3fd1b742b7395726b5] Comment 500\n",
+      "[8ab337c43ca34bf91ab17cc55890be57d3567c82] Comment 500\n",
       "running python squares.py 2\n",
       "4\n",
       "Bisecting: 250 revisions left to test after this (roughly 8 steps)\n",
-      "[1842ee96db81d26ce5c00a4b8750bd19ec380bfc] Comment 749\n",
+      "[d25fb2ac5a0ed2e9474bec5a32e52eaf6f96ff6c] Comment 749\n",
       "running python squares.py 2\n",
+      "Traceback (most recent call last):\n",
+      "  File \"squares.py\", line 9, in <module>\n",
+      "    print(integer**2)\n",
+      "TypeError: unsupported operand type(s) for ** or pow(): 'str' and 'int'\n",
       "Bisecting: 124 revisions left to test after this (roughly 7 steps)\n",
-      "[749d1352b870cc169bc3c6e9e15c69d191a2a66e] Comment 625\n",
+      "[cc0d01b552be8314dc9734c78b3363b620cb325c] Comment 624\n",
       "running python squares.py 2\n",
-      "4\n",
+      "Traceback (most recent call last):\n",
+      "  File \"squares.py\", line 9, in <module>\n",
+      "    print(integer**2)\n",
+      "TypeError: unsupported operand type(s) for ** or pow(): 'str' and 'int'\n",
       "Bisecting: 62 revisions left to test after this (roughly 6 steps)\n",
-      "[150773712a2e9e8a371f33429abf9826d3a2b65e] Comment 687\n",
+      "[4b46a6e37c388d260d61409e51864ae77ba19d6d] Comment 562\n",
       "running python squares.py 2\n",
       "4\n",
       "Bisecting: 31 revisions left to test after this (roughly 5 steps)\n",
-      "[0e12bcd2d685904abf22431381000c68ca0af230] Comment 717\n",
+      "[5eda263aaa5d0914b5871f546db26b7914895271] Breaking argument type\n",
       "running python squares.py 2\n",
+      "Traceback (most recent call last):\n",
+      "  File \"squares.py\", line 9, in <module>\n",
+      "    print(integer**2)\n",
+      "TypeError: unsupported operand type(s) for ** or pow(): 'str' and 'int'\n",
       "Bisecting: 15 revisions left to test after this (roughly 4 steps)\n",
-      "[cd59a9f75102f1b49863ad424fc35dc802522ccd] Comment 702\n",
+      "[c9097be29af1b3437905feb0969669820ea81283] Comment 577\n",
       "running python squares.py 2\n",
       "4\n",
       "Bisecting: 7 revisions left to test after this (roughly 3 steps)\n",
-      "[a105ae052d898733015676ac6709b1ffe88ed8bd] Comment 709\n",
+      "[8021453f7f6fde4319a21337968832be1cc4151a] Comment 585\n",
       "running python squares.py 2\n",
+      "4\n",
       "Bisecting: 3 revisions left to test after this (roughly 2 steps)\n",
-      "[08508dd54091baa9e00c3599cb83cd0cda5b5837] Comment 706\n",
+      "[f373b49b6545427ce00c991ca112bdc65d712fbf] Comment 589\n",
       "running python squares.py 2\n",
       "4\n",
       "Bisecting: 1 revision left to test after this (roughly 1 step)\n",
-      "[7ced4763b6ab1600aab31d18fd2592186fd78b89] Comment 707\n",
+      "[66f6530a9d0a459fc0ba132c17451d281449ffee] Comment 591\n",
       "running python squares.py 2\n",
+      "4\n",
       "Bisecting: 0 revisions left to test after this (roughly 0 steps)\n",
-      "[ebb3f4a5f4000c28bbc12d4d0187bbdad3d92241] Breaking argument type\n",
+      "[1694ac7328d0a379362dec982d8d3afe14cc98b8] Comment 592\n",
       "running python squares.py 2\n",
-      "ebb3f4a5f4000c28bbc12d4d0187bbdad3d92241 is the first bad commit\n",
-      "commit ebb3f4a5f4000c28bbc12d4d0187bbdad3d92241\n",
+      "4\n",
+      "5eda263aaa5d0914b5871f546db26b7914895271 is the first bad commit\n",
+      "commit 5eda263aaa5d0914b5871f546db26b7914895271\n",
       "Author: Shawn Siefkas <[email protected]>\n",
       "Date:   Thu Nov 14 09:23:55 2013 -0600\n",
       "\n",
       "    Breaking argument type\n",
       "\n",
-      ":100644 100644 430222f37d6aad3ba2b7f235991473e680c7e4d8 03bc808166ca5cd0a8cca51cfb522e0724a31bc6 M\tsquares.py\n",
+      " squares.py | 2 +-\n",
+      " 1 file changed, 1 insertion(+), 1 deletion(-)\n",
       "bisect run success\n"
      ]
     },
     {
      "name": "stderr",
      "output_type": "stream",
      "text": [
-      "Previous HEAD position was f85561d... Comment 500\n",
-      "Switched to branch 'buggy'\n",
-      "Traceback (most recent call last):\n",
-      "  File \"squares.py\", line 9, in <module>\n",
-      "    print(integer**2)\n",
-      "TypeError: unsupported operand type(s) for ** or pow(): 'str' and 'int'\n",
-      "Traceback (most recent call last):\n",
-      "  File \"squares.py\", line 9, in <module>\n",
-      "    print(integer**2)\n",
-      "TypeError: unsupported operand type(s) for ** or pow(): 'str' and 'int'\n",
-      "Traceback (most recent call last):\n",
-      "  File \"squares.py\", line 9, in <module>\n",
-      "    print(integer**2)\n",
-      "TypeError: unsupported operand type(s) for ** or pow(): 'str' and 'int'\n",
-      "Traceback (most recent call last):\n",
-      "  File \"squares.py\", line 9, in <module>\n",
-      "    print(integer**2)\n",
-      "TypeError: unsupported operand type(s) for ** or pow(): 'str' and 'int'\n",
-      "Traceback (most recent call last):\n",
-      "  File \"squares.py\", line 9, in <module>\n",
-      "    print(integer**2)\n",
-      "TypeError: unsupported operand type(s) for ** or pow(): 'str' and 'int'\n"
+      "Previous HEAD position was 1694ac7 Comment 592\n",
+      "Switched to branch 'buggy'\n"
      ]
     }
    ],
@@ -430,7 +441,8 @@
     "git bisect start\n",
     "git bisect bad HEAD # We know the current state is broken\n",
     "git bisect good master # We know master is good\n",
-    "git bisect run python squares.py 2"
+    "git bisect run python squares.py 2 &> gitbisect.out\n",
+    "cat gitbisect.out"
    ]
   },
   {