Documentation: bisect: add some titles to some paragraphs.
Signed-off-by: Christian Couder <chriscool@tuxfamily.org> Signed-off-by: Junio C Hamano <junkio@cox.net>
Christian Couder committed
Mar 24, 2007 at 06:30 UTC
1207f9e705bcd69af286b2f887e67ae2baad3faf
1 file changed
+21
Documentation/git-bisect.txt
+21
@@ -28,6 +28,9 @@ This command uses 'git-rev-list --bisect' option to help drive the
28
binary search process to find which change introduced a bug, given an
29
old "good" commit object name and a later "bad" commit object name.
30
31
+Basic bisect commands: start, bad, good
32
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
33
+
34
The way you use it is:
35
36
------------------------------------------------
@@ -65,6 +68,9 @@ bad", and ask for the next bisection.
68
Until you have no more left, and you'll have been left with the first
69
bad kernel rev in "refs/bisect/bad".
70
71
+Bisect reset
72
+~~~~~~~~~~~~
73
+
74
Oh, and then after you want to reset to the original head, do a
75
76
------------------------------------------------
@@ -76,6 +82,9 @@ bisection branches ("git bisect start" will do that for you too,
82
actually: it will reset the bisection state, and before it does that
83
it checks that you're not using some old bisection branch).
84
85
+Bisect visualize
86
+~~~~~~~~~~~~~~~~
87
+
88
During the bisection process, you can say
89
90
------------
@@ -84,6 +93,9 @@ $ git bisect visualize
93
94
to see the currently remaining suspects in `gitk`.
95
96
+Bisect log and bisect replay
97
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
98
+
99
The good/bad input is logged, and
100
101
------------
@@ -100,6 +112,9 @@ $ git bisect replay that-file
112
if you find later you made a mistake telling good/bad about a
113
revision.
114
115
+Avoiding to test a commit
116
+~~~~~~~~~~~~~~~~~~~~~~~~~
117
+
118
If in a middle of bisect session, you know what the bisect suggested
119
to try next is not a good one to test (e.g. the change the commit
120
introduces is known not to work in your environment and you know it
@@ -119,6 +134,9 @@ $ git reset --hard HEAD~3 # try 3 revs before what
134
Then compile and test the one you chose to try. After that, tell
135
bisect what the result was as usual.
136
137
+Cutting down bisection by giving path parameter to bisect start
138
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
139
+
140
You can further cut down the number of trials if you know what part of
141
the tree is involved in the problem you are tracking down, by giving
142
paths parameters when you say `bisect start`, like this:
@@ -127,6 +145,9 @@ paths parameters when you say `bisect start`, like this:
145
$ git bisect start arch/i386 include/asm-i386
146
------------
147
148
+Bisect run
149
+~~~~~~~~~~
150
+
151
If you have a script that can tell if the current source code is good
152
or bad, you can automatically bisect using:
153