[PATCH] Documentation - More examples for git bisect

[PATCH] Documentation - More examples for git bisect

[John Tapsell]

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

Signed-off-by: John Tapsell
---
 Documentation/git-bisect.txt |   18 +++++++++++++++++-
 1 files changed, 17 insertions(+), 1 deletions(-)

diff --git a/Documentation/git-bisect.txt b/Documentation/git-bisect.txt
index 147ea38..e65c1ca 100644
--- 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:
 
 ------------
-$ git bisect run my_script
+$ git bisect run my_script arguments
 ------------
 
 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
 ------------
 
+* 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:
 +
 ------------
@@ -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.
 
+* 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>
-- 
1.6.2.97.g1bcd6.dirty

Re: [PATCH] Documentation - More examples for git bisect

[Christian Couder]

Le jeudi 5 mars 2009, John Tapsell a écrit :
> Including passing parameters to the programs, and running more
> complicated checks without requiring a seperate shell script.
>
> Signed-off-by: John Tapsell

That looks good to me, except perhaps that your signed-off-by has no email 
address, but I don't know if it's a problem or not.

Acked-by: Christian Couder <chriscool@tuxfamily.org>

Thanks,
Christian.

Re: [PATCH] Documentation - More examples for git bisect

[John Tapsell]

2009/3/5 Christian Couder <chriscool@tuxfamily.org>:
> Le jeudi 5 mars 2009, John Tapsell a écrit :
>> Including passing parameters to the programs, and running more
>> complicated checks without requiring a seperate shell script.
>>
>> Signed-off-by: John Tapsell
>
> That looks good to me, except perhaps that your signed-off-by has no email
> address, but I don't know if it's a problem or not.

Opps.  Signed-off-by: John Tapsell <johnflux@gmail.com>

>
> Acked-by: Christian Couder <chriscool@tuxfamily.org>
>
> Thanks,
> Christian.
>

Re: [PATCH] Documentation - More examples for git bisect

[Christian Couder]

On a second look here are a few nit picks.

First the patch title could be:

"Documentation: More examples for git bisect"

instead of:

"Documentation - More examples for git bisect"

as it would be more consistent with other patches.

Le jeudi 5 mars 2009, John Tapsell a écrit :
> Including passing parameters to the programs, and running more
> complicated checks without requiring a seperate shell script.
>
> Signed-off-by: John Tapsell
> ---
>  Documentation/git-bisect.txt |   18 +++++++++++++++++-
>  1 files changed, 17 insertions(+), 1 deletions(-)
>
> diff --git a/Documentation/git-bisect.txt b/Documentation/git-bisect.txt
> index 147ea38..e65c1ca 100644
> --- 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:
>
>  ------------
> -$ git bisect run my_script
> +$ git bisect run my_script arguments
>  ------------
>
>  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
>  ------------
>
> +* 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
> +------------

Perhaps we should add that the above may not work well if there are some 
commits that don't build. And that it is fixed in the example below this 
one.

>  * 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.
>
> +* Automatically bisect a broken test suite:

The title of the previous example is 

* Automatically bisect a broken test case:

so if it is the same, then it should perhaps have the same title or perhaps:

* Automatically bisect a broken test case simplified:

or something like that.

> ++
> +------------
> +$ 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.
> +

Thanks,
Christian.