git-bisect.txt: clarify that reset quits bisect
"reset" can be easily misunderstood as resetting a bisect session to its start without finishing it. Clarify that it actually quits the bisect session. Reported-by: Andreas Mohr <andi@lisas.de> Signed-off-by: Michael J Gruber <git@drmicha.warpmail.net> Reviewed-by: Jonathan Nieder <jrnieder@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Michael J Gruber committed
Feb 11, 2013 at 09:35 UTC
c787a454524b0c59cb7ca42f09d106554e0224b8
1 file changed
+6
-1
Documentation/git-bisect.txt
+6
-1
@@ -83,7 +83,7 @@ Bisect reset
83
~~~~~~~~~~~~
84
85
After a bisect session, to clean up the bisection state and return to
86
-the original HEAD, issue the following command:
86
+the original HEAD (i.e., to quit bisecting), issue the following command:
87
88
------------------------------------------------
89
$ git bisect reset
@@ -284,6 +284,7 @@ EXAMPLES
284
------------
285
$ git bisect start HEAD v1.2 -- # HEAD is bad, v1.2 is good
286
$ git bisect run make # "make" builds the app
287
+$ git bisect reset # quit the bisect session
288
------------
289
290
* Automatically bisect a test failure between origin and HEAD:
@@ -291,6 +292,7 @@ $ git bisect run make # "make" builds the app
292
------------
293
$ git bisect start HEAD origin -- # HEAD is bad, origin is good
294
$ git bisect run make test # "make test" builds and tests
295
+$ git bisect reset # quit the bisect session
296
------------
297
298
* Automatically bisect a broken test case:
@@ -302,6 +304,7 @@ make || exit 125 # this skips broken builds
304
~/check_test_case.sh # does the test case pass?
305
$ git bisect start HEAD HEAD~10 -- # culprit is among the last 10
306
$ git bisect run ~/test.sh
307
+$ git bisect reset # quit the bisect session
308
------------
309
+
310
Here we use a "test.sh" custom script. In this script, if "make"
@@ -351,6 +354,7 @@ use `git cherry-pick` instead of `git merge`.)
354
------------
355
$ git bisect start HEAD HEAD~10 -- # culprit is among the last 10
356
$ git bisect run sh -c "make || exit 125; ~/check_test_case.sh"
357
+$ git bisect reset # quit the bisect session
358
------------
359
+
360
This shows that you can do without a run script if you write the test
@@ -368,6 +372,7 @@ $ git bisect run sh -c '
372
rm -f tmp.$$
373
test $rc = 0'
374
375
+$ git bisect reset # quit the bisect session
376
------------
377
+
378
In this case, when 'git bisect run' finishes, bisect/bad will refer to a commit that