Documentation - More examples for git bisect

Including passing parameters to the programs, and running more
complicated checks without requiring a seperate shell script.

Signed-off-by: John Tapsell <johnflux@gmail.com>
Acked-by: Christian Couder <chriscool@tuxfamily.org>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/Documentation/git-bisect.txt b/Documentation/git-bisect.txt
index 147ea381977a459f1fa624408cc3af3e9b9f3bd5..e65c1cae8b3da4efae7571628c1586cbb56151ae 100644 (file)
--- a/Documentation/git-bisect.txt
+++ b/Documentation/git-bisect.txt
@@ -212,7 +212,7 @@ If you have a script that can tell if the current source code is good
 or bad, you can automatically bisect using:
 
 ------------
 or bad, you can automatically bisect using:
 
 ------------

-$ git bisect run my_script
+$ git bisect run my_script arguments

 ------------
 
 Note that the "run" script (`my_script` in the above example) should
 ------------
 
 Note that the "run" script (`my_script` in the above example) should


@@ -252,6 +252,13 @@ $ git bisect start HEAD v1.2 --      # HEAD is bad, v1.2 is good
 $ git bisect run make                # "make" builds the app
 ------------
 
 $ git bisect run make                # "make" builds the app
 ------------
 

+* Automatically bisect a test failure between origin and HEAD:
++
+------------
+$ git bisect start HEAD origin --    # HEAD is bad, origin is good
+$ git bisect run make test           # "make test" builds and tests
+------------
+

 * Automatically bisect a broken test suite:
 +
 ------------
 * Automatically bisect a broken test suite:
 +
 ------------


@@ -291,6 +298,15 @@ It's safer if both "test.sh" and "check_test_case.sh" scripts are
 outside the repo to prevent interactions between the bisect, make and
 test processes and the scripts.
 
 outside the repo to prevent interactions between the bisect, make and
 test processes and the scripts.
 

+* Automatically bisect a broken test suite:
++
+------------
+$ git bisect start HEAD HEAD~10 --   # culprit is among the last 10
+$ git bisect run sh -c "make || exit 125; ~/check_test_case.sh"
+------------
++
+Does the same as the previous example, but on a single line.
+

 Author
 ------
 Written by Linus Torvalds <torvalds@osdl.org>
 Author
 ------
 Written by Linus Torvalds <torvalds@osdl.org>