[PATCH 2/2] Documentation: bisect: add a few "git bisect run" examples
From: Christian Couder <hidden>
Date: 2016-06-15 22:44:34
Subsystem:
documentation, the rest · Maintainers:
Jonathan Corbet, Linus Torvalds
Before this patch, there were no proper "git bisect run" example. --- Documentation/git-bisect.txt | 26 ++++++++++++++++++++++++++ 1 files changed, 26 insertions(+), 0 deletions(-)
diff --git a/Documentation/git-bisect.txt b/Documentation/git-bisect.txt
index 698ffde..a05963a 100644
--- a/Documentation/git-bisect.txt
+++ b/Documentation/git-bisect.txt@@ -224,6 +224,32 @@ tree to the pristine state. Finally the "run" script can exit with the status of the real test to let "git bisect run" command loop to know the outcome. +EXAMPLES +-------- + +* Automatically bisect a broken build between v1.2 and HEAD: ++ +------------ +$ git bisect start HEAD v1.2 -- # HEAD is bad, v1.2 is good +$ git bisect run make # "make" builds the app +------------ + +* Automatically bisect a broken test case using a custom script: ++ +------------ +echo "#"\!"/bin/sh" > ~/test.sh +echo "make install || exit 125" >> ~/test.sh +echo "~/check_test_case.sh" >> ~/test.sh +chmod u+x ~/test.sh +$ git bisect start v1.3 v1.1 -- # v1.3 is bad, v1.1 is good +$ git bisect run ~/test.sh +------------ ++ +Here we first create the "test.sh" custom script. In this script, if +"make install" fails, we "skip" the current commit. +And "check_test_case.sh" should "exit 0", if the test case passes, and +"exit 1" (for example) otherwise. + Author ------ Written by Linus Torvalds <torvalds@osdl.org>
--
1.5.5.1.126.g9ca01