kernel
/
git
mirror of https://git.kernel.org/pub/scm/git/git.git
1
0
Fork 0
Code Releases Activity

Documentation: reword example text in git-bisect.txt. 

Avoid splitting sentences across examples of command usage.

Signed-off-by: David J. Mellor <dmellor@whistlingcat.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
maint
David J. Mellor 2009-03-19 20:35:34 -07:00 committed by Junio C Hamano
parent ee9cf14d25
commit 4306bcb4e1
1 changed files with 24 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
Documentation/git-bisect.txt
View File

@ -50,28 +50,29 @@ $ git bisect good v2.6.13-rc2 # v2.6.13-rc2 was the last version
------------------------------------------------ ------------------------------------------------


When you have specified at least one bad and one good version, the When you have specified at least one bad and one good version, the
command bisects the revision tree and outputs something similar to: command bisects the revision tree and outputs something similar to
the following:


------------------------------------------------ ------------------------------------------------
Bisecting: 675 revisions left to test after this Bisecting: 675 revisions left to test after this
------------------------------------------------ ------------------------------------------------


and then checks out the state in the middle. You would now compile The state in the middle of the set of revisions is then checked out.
that kernel and boot it. If the booted kernel works correctly, you You would now compile that kernel and boot it. If the booted kernel
would then issue the following command: works correctly, you would then issue the following command:


------------------------------------------------ ------------------------------------------------
$ git bisect good # this one is good $ git bisect good # this one is good
------------------------------------------------ ------------------------------------------------


which would then output something similar to: The output of this command would be something similar to the following:


------------------------------------------------ ------------------------------------------------
Bisecting: 337 revisions left to test after this Bisecting: 337 revisions left to test after this
------------------------------------------------ ------------------------------------------------


and you continue along, compiling that one, testing it, and depending You keep repeating this process, compiling the tree, testing it, and
on whether it is good or bad issuing the command "git bisect good" depending on whether it is good or bad issuing the command "git bisect good"
or "git bisect bad" to ask for the next bisection. or "git bisect bad" to ask for the next bisection.


Eventually there will be no more revisions left to bisect, and you Eventually there will be no more revisions left to bisect, and you
@ -81,7 +82,7 @@ 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, you issue the
command: following command:


------------------------------------------------ ------------------------------------------------
$ git bisect reset $ git bisect reset
@ -94,14 +95,14 @@ the bisection state).
Bisect visualize Bisect visualize
~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~


During the bisection process, you issue the command: To see the currently remaining suspects in 'gitk', the following command
is issued during the bisection process:


------------ ------------
$ git bisect visualize $ git bisect visualize
------------ ------------


to see the currently remaining suspects in 'gitk'. `view` may also `view` may also be used as a synonym for `visualize`.
be used as a synonym for `visualize`.


If the 'DISPLAY' environment variable is not set, 'git log' is used If the 'DISPLAY' environment variable is not set, 'git log' is used
instead. You can also give command line options such as `-p` and instead. You can also give command line options such as `-p` and
@ -114,16 +115,17 @@ $ git bisect view --stat
Bisect log and bisect replay Bisect log and bisect replay
~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~


After having marked revisions as good or bad, then: After having marked revisions as good or bad, you issue the following
command to show what has been done so far:


------------ ------------
$ git bisect log $ git bisect log
------------ ------------


shows what you have done so far. If you discover that you made a mistake If you discover that you made a mistake in specifying the status of a
in specifying the status of a revision, you can save the output of this revision, you can save the output of this command to a file, edit it to
command to a file, edit it to remove the incorrect entries, and then issue remove the incorrect entries, and then issue the following commands to
the following commands to return to a corrected state: return to a corrected state:


------------ ------------
$ git bisect reset $ git bisect reset
@ -173,8 +175,8 @@ using the "'<commit1>'..'<commit2>'" notation. For example:
$ git bisect skip v2.5..v2.6 $ git bisect skip v2.5..v2.6
------------ ------------


would mean that no commit between `v2.5` excluded and `v2.6` included The effect of this would be that no commit between `v2.5` excluded and
can be tested. `v2.6` included could be tested.


Note that if you also want to skip the first commit of the range you Note that if you also want to skip the first commit of the range you
would issue the command: would issue the command:
@ -183,14 +185,16 @@ would issue the command:
$ git bisect skip v2.5 v2.5..v2.6 $ git bisect skip v2.5 v2.5..v2.6
------------ ------------


and the commit pointed to by `v2.5` would also be skipped. This would cause the commits between `v2.5` included and `v2.6` included
to be skipped.



Cutting down bisection by giving more parameters to bisect start Cutting down bisection by giving more parameters to bisect start
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~


You can further cut down the number of trials, if you know what part of You can further cut down the number of trials, if you know what part of
the tree is involved in the problem you are tracking down, by specifying the tree is involved in the problem you are tracking down, by specifying
path parameters when issuing the `bisect start` command, like this: path parameters when issuing the `bisect start` command:


------------ ------------
$ git bisect start -- arch/i386 include/asm-i386 $ git bisect start -- arch/i386 include/asm-i386