From: Junio C Hamano <gitster@pobox.com>
Date: Thu, 14 Feb 2013 18:29:01 +0000 (-0800)
Subject: Merge branch 'mg/bisect-doc'
X-Git-Tag: v1.8.2-rc0~22
X-Git-Url: https://git.lorimer.id.au/gitweb.git/diff_plain/eb213fc3fce895e1b279247dd5e5fa6c168f90e4?hp=-c

Merge branch 'mg/bisect-doc'

* mg/bisect-doc:
git-bisect.txt: clarify that reset quits bisect
---

eb213fc3fce895e1b279247dd5e5fa6c168f90e4
diff --combined Documentation/git-bisect.txt
index b4831bb0cf,038514b51e..f986c5cb3a
--- a/Documentation/git-bisect.txt
+++ b/Documentation/git-bisect.txt
@@@ -83,7 -83,7 +83,7 @@@ Bisect rese
  ~~~~~~~~~~~~
  
  After a bisect session, to clean up the bisection state and return to
- the original HEAD, issue the following command:
+ the original HEAD (i.e., to quit bisecting), issue the following command:
  
  ------------------------------------------------
  $ git bisect reset
@@@ -169,14 -169,14 +169,14 @@@ the revision as good or bad in the usua
  Bisect skip
  ~~~~~~~~~~~~
  
 -Instead of choosing by yourself a nearby commit, you can ask git
 +Instead of choosing by yourself a nearby commit, you can ask Git
  to do it for you by issuing the command:
  
  ------------
  $ git bisect skip                 # Current version cannot be tested
  ------------
  
 -But git may eventually be unable to tell the first bad commit among
 +But Git may eventually be unable to tell the first bad commit among
  a bad commit and one or more skipped commits.
  
  You can even skip a range of commits, instead of just one commit,
@@@ -284,6 -284,7 +284,7 @@@ EXAMPLE
  ------------
  $ git bisect start HEAD v1.2 --      # HEAD is bad, v1.2 is good
  $ git bisect run make                # "make" builds the app
+ $ git bisect reset                   # quit the bisect session
  ------------
  
  * Automatically bisect a test failure between origin and HEAD:
@@@ -291,6 -292,7 +292,7 @@@
  ------------
  $ git bisect start HEAD origin --    # HEAD is bad, origin is good
  $ git bisect run make test           # "make test" builds and tests
+ $ git bisect reset                   # quit the bisect session
  ------------
  
  * Automatically bisect a broken test case:
@@@ -302,6 -304,7 +304,7 @@@ make || exit 125                     # 
  ~/check_test_case.sh                 # does the test case pass?
  $ git bisect start HEAD HEAD~10 --   # culprit is among the last 10
  $ git bisect run ~/test.sh
+ $ git bisect reset                   # quit the bisect session
  ------------
  +
  Here we use a "test.sh" custom script. In this script, if "make"
@@@ -351,6 -354,7 +354,7 @@@ use `git cherry-pick` instead of `git m
  ------------
  $ git bisect start HEAD HEAD~10 --   # culprit is among the last 10
  $ git bisect run sh -c "make || exit 125; ~/check_test_case.sh"
+ $ git bisect reset                   # quit the bisect session
  ------------
  +
  This shows that you can do without a run script if you write the test
@@@ -368,6 -372,7 +372,7 @@@ $ git bisect run sh -c 
  	rm -f tmp.$$
  	test $rc = 0'
  
+ $ git bisect reset                   # quit the bisect session
  ------------
  +
  In this case, when 'git bisect run' finishes, bisect/bad will refer to a commit that