Merge branch 'dm/maint-docco'
authorJunio C Hamano <gitster@pobox.com>
Thu, 26 Mar 2009 07:26:04 +0000 (00:26 -0700)
committerJunio C Hamano <gitster@pobox.com>
Thu, 26 Mar 2009 07:26:04 +0000 (00:26 -0700)
* dm/maint-docco:
Documentation: Remove spurious uses of "you" in git-bisect.txt.
Documentation: minor grammatical fix in git-check-ref-format.txt
Documentation: minor grammatical fixes in git-check-attr.txt
Documentation: minor grammatical fixes in git-cat-file.txt
Documentation: minor grammatical fixes and rewording in git-bundle.txt
Documentation: remove some uses of the passive voice in git-bisect.txt

1  2 
Documentation/git-bisect.txt
index 93d9fc0299c0f4aeeb97f6ec228415d67c398dcb,e5862b9dbbbd69fcd57e8ec85fb0b08f5bf221d0..ffc02c737cf0a8d2bdb3cd812e0a23d43ee27fd7
@@@ -81,7 -81,7 +81,7 @@@ will have been left with the first bad 
  Bisect reset
  ~~~~~~~~~~~~
  
- To return to the original head after a bisect session, you issue the
+ To return to the original head after a bisect session, issue the
  following command:
  
  ------------------------------------------------
@@@ -95,8 -95,8 +95,8 @@@ the bisection state)
  Bisect visualize
  ~~~~~~~~~~~~~~~~
  
- To see the currently remaining suspects in 'gitk', the following command
is issued during the bisection process:
+ To see the currently remaining suspects in 'gitk', issue the following
command during the bisection process:
  
  ------------
  $ git bisect visualize
@@@ -115,7 -115,7 +115,7 @@@ $ git bisect view --sta
  Bisect log and bisect replay
  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  
- After having marked revisions as good or bad, you issue the following
+ After having marked revisions as good or bad, issue the following
  command to show what has been done so far:
  
  ------------
@@@ -135,7 -135,7 +135,7 @@@ $ git bisect replay that-fil
  Avoiding testing a commit
  ~~~~~~~~~~~~~~~~~~~~~~~~~
  
- If in the middle of a bisect session, you know that the next suggested
+ If, in the middle of a bisect session, you know that the next suggested
  revision is not a good one to test (e.g. the change the commit
  introduces is known not to work in your environment and you know it
  does not have anything to do with the bug you are chasing), you may
@@@ -151,8 -151,8 +151,8 @@@ $ git reset --hard HEAD~3          # try 3 revi
                                        # was suggested
  ------------
  
- Then compile and test the chosen revision. Afterwards the revision
is marked as good or bad in the usual manner.
+ Then compile and test the chosen revision, and afterwards mark
the revision as good or bad in the usual manner.
  
  Bisect skip
  ~~~~~~~~~~~~
@@@ -175,8 -175,8 +175,8 @@@ using the "'<commit1>'..'<commit2>'" no
  $ git bisect skip v2.5..v2.6
  ------------
  
- The effect of this would be that no commit between `v2.5` excluded and
`v2.6` included could be tested.
+ This tells the bisect process that no commit after `v2.5`, up to and
including `v2.6`, should be tested.
  
  Note that if you also want to skip the first commit of the range you
  would issue the command:
  $ git bisect skip v2.5 v2.5..v2.6
  ------------
  
- This would cause the commits between `v2.5` included and `v2.6` included
to be skipped.
+ This tells the bisect process that the commits between `v2.5` included
and `v2.6` included should be skipped.
  
  
  Cutting down bisection by giving more parameters to bisect start
@@@ -217,7 -217,7 +217,7 @@@ If you have a script that can tell if t
  or bad, you can bisect by issuing the command:
  
  ------------
 -$ git bisect run my_script
 +$ git bisect run my_script arguments
  ------------
  
  Note that the script (`my_script` in the above example) should
@@@ -257,13 -257,6 +257,13 @@@ $ git bisect start HEAD v1.2 --      # 
  $ 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:
  +
  ------------
@@@ -303,15 -296,6 +303,15 @@@ It is safer if both "test.sh" and "chec
  outside the repository 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>