Skip to content

Commit ee9cf14

Browse files
dmellorgitster
authored andcommitted
Documentation: reworded the "Description" section of git-bisect.txt.
Added fixes missing from 2364259. Signed-off-by: David J. Mellor <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent e5ac121 commit ee9cf14

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

Documentation/git-bisect.txt

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -114,21 +114,22 @@ $ git bisect view --stat
114114
Bisect log and bisect replay
115115
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
116116

117-
The good/bad input is logged, and:
117+
After having marked revisions as good or bad, then:
118118

119119
------------
120120
$ git bisect log
121121
------------
122122

123-
shows what you have done so far. You can truncate its output somewhere
124-
and save it in a file, and run:
123+
shows what you have done so far. If you discover that you made a mistake
124+
in specifying the status of a revision, you can save the output of this
125+
command to a file, edit it to remove the incorrect entries, and then issue
126+
the following commands to return to a corrected state:
125127

126128
------------
129+
$ git bisect reset
127130
$ git bisect replay that-file
128131
------------
129132

130-
if you find later that you made a mistake specifying revisions as good/bad.
131-
132133
Avoiding testing a commit
133134
~~~~~~~~~~~~~~~~~~~~~~~~~
134135

@@ -141,15 +142,15 @@ want to find a nearby commit and try that instead.
141142
For example:
142143

143144
------------
144-
$ git bisect good/bad # previous round was good/bad.
145+
$ git bisect good/bad # previous round was good or bad.
145146
Bisecting: 337 revisions left to test after this
146147
$ git bisect visualize # oops, that is uninteresting.
147148
$ git reset --hard HEAD~3 # try 3 revisions before what
148149
# was suggested
149150
------------
150151

151152
Then compile and test the chosen revision. Afterwards the revision
152-
is marked as good/bad in the usual manner.
153+
is marked as good or bad in the usual manner.
153154

154155
Bisect skip
155156
~~~~~~~~~~~~
@@ -240,7 +241,7 @@ before compiling, run the real test, and afterwards decide if the
240241
revision (possibly with the needed patch) passed the test and then
241242
rewind the tree to the pristine state. Finally the script should exit
242243
with the status of the real test to let the "git bisect run" command loop
243-
to determine the eventual outcome of the bisect session.
244+
determine the eventual outcome of the bisect session.
244245

245246
EXAMPLES
246247
--------

0 commit comments

Comments
 (0)