@matheusbsbs / matheus-bagliano / commits / fed820ad56
Fork 0

Documentation: bisect: reformat more paragraphs.

Signed-off-by: Christian Couder <chriscool@tuxfamily.org> Signed-off-by: Junio C Hamano <junkio@cox.net>

Christian Couder committed Mar 24, 2007 at 06:31 UTC fed820ad5662d8b6f11b5e7f788fa87afe1ad919
1 file changed +39 -34
Documentation/git-bisect.txt
+39 -34
@@ -12,8 +12,8 @@ SYNOPSIS
12
13 DESCRIPTION
14 -----------
15 -The command takes various subcommands, and different options
16 -depending on the subcommand:
15 +The command takes various subcommands, and different options depending
16 +on the subcommand:
17
18 git bisect start [<paths>...]
19 git bisect bad <rev>
@@ -24,10 +24,9 @@ depending on the subcommand:
24 git bisect log
25 git bisect run <cmd>...
26
27 -This command uses 'git-rev-list --bisect' option to help drive
28 -the binary search process to find which change introduced a bug,
29 -given an old "good" commit object name and a later "bad" commit
30 -object name.
27 +This command uses 'git-rev-list --bisect' option to help drive the
28 +binary search process to find which change introduced a bug, given an
29 +old "good" commit object name and a later "bad" commit object name.
30
31 The way you use it is:
32
@@ -38,15 +37,16 @@ $ git bisect good v2.6.13-rc2 # v2.6.13-rc2 was the last version
37 # tested that was good
38 ------------------------------------------------
39
41 -When you give at least one bad and one good versions, it will
42 -bisect the revision tree and say something like:
40 +When you give at least one bad and one good versions, it will bisect
41 +the revision tree and say something like:
42
43 ------------------------------------------------
44 Bisecting: 675 revisions left to test after this
45 ------------------------------------------------
46
48 -and check out the state in the middle. Now, compile that kernel, and boot
49 -it. Now, let's say that this booted kernel works fine, then just do
47 +and check out the state in the middle. Now, compile that kernel, and
48 +boot it. Now, let's say that this booted kernel works fine, then just
49 +do
50
51 ------------------------------------------------
52 $ git bisect good # this one is good
@@ -58,12 +58,12 @@ which will now say
58 Bisecting: 337 revisions left to test after this
59 ------------------------------------------------
60
61 -and you continue along, compiling that one, testing it, and depending on
62 -whether it is good or bad, you say "git bisect good" or "git bisect bad",
63 -and ask for the next bisection.
61 +and you continue along, compiling that one, testing it, and depending
62 +on whether it is good or bad, you say "git bisect good" or "git bisect
63 +bad", and ask for the next bisection.
64
65 -Until you have no more left, and you'll have been left with the first bad
66 -kernel rev in "refs/bisect/bad".
65 +Until you have no more left, and you'll have been left with the first
66 +bad kernel rev in "refs/bisect/bad".
67
68 Oh, and then after you want to reset to the original head, do a
69
@@ -71,10 +71,10 @@ Oh, and then after you want to reset to the original head, do a
71 $ git bisect reset
72 ------------------------------------------------
73
74 -to get back to the master branch, instead of being in one of the bisection
75 -branches ("git bisect start" will do that for you too, actually: it will
76 -reset the bisection state, and before it does that it checks that you're
77 -not using some old bisection branch).
74 +to get back to the master branch, instead of being in one of the
75 +bisection branches ("git bisect start" will do that for you too,
76 +actually: it will reset the bisection state, and before it does that
77 +it checks that you're not using some old bisection branch).
78
79 During the bisection process, you can say
80
@@ -84,9 +84,14 @@ $ git bisect visualize
84
85 to see the currently remaining suspects in `gitk`.
86
87 -The good/bad input is logged, and `git bisect
88 -log` shows what you have done so far. You can truncate its
89 -output somewhere and save it in a file, and run
87 +The good/bad input is logged, and
88 +
89 +------------
90 +$ git bisect log
91 +------------
92 +
93 +shows what you have done so far. You can truncate its output somewhere
94 +and save it in a file, and run
95
96 ------------
97 $ git bisect replay that-file
@@ -95,12 +100,13 @@ $ git bisect replay that-file
100 if you find later you made a mistake telling good/bad about a
101 revision.
102
98 -If in a middle of bisect session, you know what the bisect
99 -suggested to try next is not a good one to test (e.g. the change
100 -the commit introduces is known not to work in your environment
101 -and you know it does not have anything to do with the bug you
102 -are chasing), you may want to find a near-by commit and try that
103 -instead. It goes something like this:
103 +If in a middle of bisect session, you know what the bisect suggested
104 +to try next is not a good one to test (e.g. the change the commit
105 +introduces is known not to work in your environment and you know it
106 +does not have anything to do with the bug you are chasing), you may
107 +want to find a near-by commit and try that instead.
108 +
109 +It goes something like this:
110
111 ------------
112 $ git bisect good/bad # previous round was good/bad.
@@ -110,13 +116,12 @@ $ git reset --hard HEAD~3 # try 3 revs before what
116 # was suggested
117 ------------
118
113 -Then compile and test the one you chose to try. After that,
114 -tell bisect what the result was as usual.
119 +Then compile and test the one you chose to try. After that, tell
120 +bisect what the result was as usual.
121
116 -You can further cut down the number of trials if you know what
117 -part of the tree is involved in the problem you are tracking
118 -down, by giving paths parameters when you say `bisect start`,
119 -like this:
122 +You can further cut down the number of trials if you know what part of
123 +the tree is involved in the problem you are tracking down, by giving
124 +paths parameters when you say `bisect start`, like this:
125
126 ------------
127 $ git bisect start arch/i386 include/asm-i386