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>
David J. Mellor committed
Mar 19, 2009 at 20:35 UTC
4306bcb4e14ab708f0083bcf0339fa77a4005c05
1 file changed
+24
-20
Documentation/git-bisect.txt
+24
-20
@@ -50,28 +50,29 @@ $ git bisect good v2.6.13-rc2 # v2.6.13-rc2 was the last version
50
------------------------------------------------
51
52
When you have specified at least one bad and one good version, the
53
-command bisects the revision tree and outputs something similar to:
53
+command bisects the revision tree and outputs something similar to
54
+the following:
55
56
------------------------------------------------
57
Bisecting: 675 revisions left to test after this
58
------------------------------------------------
59
59
-and then checks out the state in the middle. You would now compile
60
-that kernel and boot it. If the booted kernel works correctly, you
61
-would then issue the following command:
60
+The state in the middle of the set of revisions is then checked out.
61
+You would now compile that kernel and boot it. If the booted kernel
62
+works correctly, you would then issue the following command:
63
64
------------------------------------------------
65
$ git bisect good # this one is good
66
------------------------------------------------
67
67
-which would then output something similar to:
68
+The output of this command would be something similar to the following:
69
70
------------------------------------------------
71
Bisecting: 337 revisions left to test after this
72
------------------------------------------------
73
73
-and you continue along, compiling that one, testing it, and depending
74
-on whether it is good or bad issuing the command "git bisect good"
74
+You keep repeating this process, compiling the tree, testing it, and
75
+depending on whether it is good or bad issuing the command "git bisect good"
76
or "git bisect bad" to ask for the next bisection.
77
78
Eventually there will be no more revisions left to bisect, and you
@@ -81,7 +82,7 @@ Bisect reset
82
~~~~~~~~~~~~
83
84
To return to the original head after a bisect session, you issue the
84
-command:
85
+following command:
86
87
------------------------------------------------
88
$ git bisect reset
@@ -94,14 +95,14 @@ the bisection state).
95
Bisect visualize
96
~~~~~~~~~~~~~~~~
97
97
-During the bisection process, you issue the command:
98
+To see the currently remaining suspects in 'gitk', the following command
99
+is issued during the bisection process:
100
101
------------
102
$ git bisect visualize
103
------------
104
103
-to see the currently remaining suspects in 'gitk'. `view` may also
104
-be used as a synonym for `visualize`.
105
+`view` may also be used as a synonym for `visualize`.
106
107
If the 'DISPLAY' environment variable is not set, 'git log' is used
108
instead. You can also give command line options such as `-p` and
@@ -114,16 +115,17 @@ $ git bisect view --stat
115
Bisect log and bisect replay
116
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
117
117
-After having marked revisions as good or bad, then:
118
+After having marked revisions as good or bad, you issue the following
119
+command to show what has been done so far:
120
121
------------
122
$ git bisect log
123
------------
124
123
-shows what you have done so far. If you discover that you made a mistake
124
-in specifying the status of a revision, you can save the output of this
125
-command to a file, edit it to remove the incorrect entries, and then issue
126
-the following commands to return to a corrected state:
125
+If you discover that you made a mistake in specifying the status of a
126
+revision, you can save the output of this command to a file, edit it to
127
+remove the incorrect entries, and then issue the following commands to
128
+return to a corrected state:
129
130
------------
131
$ git bisect reset
@@ -173,8 +175,8 @@ using the "'<commit1>'..'<commit2>'" notation. For example:
175
$ git bisect skip v2.5..v2.6
176
------------
177
176
-would mean that no commit between `v2.5` excluded and `v2.6` included
177
-can be tested.
178
+The effect of this would be that no commit between `v2.5` excluded and
179
+`v2.6` included could be tested.
180
181
Note that if you also want to skip the first commit of the range you
182
would issue the command:
@@ -183,14 +185,16 @@ would issue the command:
185
$ git bisect skip v2.5 v2.5..v2.6
186
------------
187
186
-and the commit pointed to by `v2.5` would also be skipped.
188
+This would cause the commits between `v2.5` included and `v2.6` included
189
+to be skipped.
190
+
191
192
Cutting down bisection by giving more parameters to bisect start
193
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
194
195
You can further cut down the number of trials, if you know what part of
196
the tree is involved in the problem you are tracking down, by specifying
193
-path parameters when issuing the `bisect start` command, like this:
197
+path parameters when issuing the `bisect start` command:
198
199
------------
200
$ git bisect start -- arch/i386 include/asm-i386