summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDavid J. Mellor <dmellor@whistlingcat.com>2009-03-19 07:00:12 (GMT)
committerJunio C Hamano <gitster@pobox.com>2009-03-19 08:38:35 (GMT)
commitee9cf14d25267aaed4b1533f92e9e5e74d5a4383 (patch)
tree7fc32623be60ee43cb35a68c1cd806360c3818a6
parente5ac1217eb2639df1d39fdcd249a35d99e8a7a8e (diff)
downloadgit-ee9cf14d25267aaed4b1533f92e9e5e74d5a4383.zip
git-ee9cf14d25267aaed4b1533f92e9e5e74d5a4383.tar.gz
git-ee9cf14d25267aaed4b1533f92e9e5e74d5a4383.tar.bz2
Documentation: reworded the "Description" section of git-bisect.txt.
Added fixes missing from 2364259. Signed-off-by: David J. Mellor <dmellor@whistlingcat.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
-rw-r--r--Documentation/git-bisect.txt17
1 files changed, 9 insertions, 8 deletions
diff --git a/Documentation/git-bisect.txt b/Documentation/git-bisect.txt
index ef82bb8..9b4d9ce 100644
--- a/Documentation/git-bisect.txt
+++ b/Documentation/git-bisect.txt
@@ -114,21 +114,22 @@ $ git bisect view --stat
Bisect log and bisect replay
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-The good/bad input is logged, and:
+After having marked revisions as good or bad, then:
------------
$ git bisect log
------------
-shows what you have done so far. You can truncate its output somewhere
-and save it in a file, and run:
+shows what you have done so far. If you discover that you made a mistake
+in specifying the status of a revision, you can save the output of this
+command to a file, edit it to remove the incorrect entries, and then issue
+the following commands to return to a corrected state:
------------
+$ git bisect reset
$ git bisect replay that-file
------------
-if you find later that you made a mistake specifying revisions as good/bad.
-
Avoiding testing a commit
~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -141,7 +142,7 @@ want to find a nearby commit and try that instead.
For example:
------------
-$ git bisect good/bad # previous round was good/bad.
+$ git bisect good/bad # previous round was good or bad.
Bisecting: 337 revisions left to test after this
$ git bisect visualize # oops, that is uninteresting.
$ git reset --hard HEAD~3 # try 3 revisions before what
@@ -149,7 +150,7 @@ $ git reset --hard HEAD~3 # try 3 revisions before what
------------
Then compile and test the chosen revision. Afterwards the revision
-is marked as good/bad in the usual manner.
+is marked as good or bad in the usual manner.
Bisect skip
~~~~~~~~~~~~
@@ -240,7 +241,7 @@ before compiling, run the real test, and afterwards decide if the
revision (possibly with the needed patch) passed the test and then
rewind the tree to the pristine state. Finally the script should exit
with the status of the real test to let the "git bisect run" command loop
-to determine the eventual outcome of the bisect session.
+determine the eventual outcome of the bisect session.
EXAMPLES
--------