Skip to content

Commit 4306bcb

Browse files
dmellorgitster
authored andcommitted
Documentation: reword example text in git-bisect.txt.
Avoid splitting sentences across examples of command usage. Signed-off-by: David J. Mellor <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent ee9cf14 commit 4306bcb

File tree

1 file changed

+24
-20
lines changed

1 file changed

+24
-20
lines changed

Documentation/git-bisect.txt

Lines changed: 24 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -50,28 +50,29 @@ $ git bisect good v2.6.13-rc2 # v2.6.13-rc2 was the last version
5050
------------------------------------------------
5151

5252
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:
5455

5556
------------------------------------------------
5657
Bisecting: 675 revisions left to test after this
5758
------------------------------------------------
5859

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:
6263

6364
------------------------------------------------
6465
$ git bisect good # this one is good
6566
------------------------------------------------
6667

67-
which would then output something similar to:
68+
The output of this command would be something similar to the following:
6869

6970
------------------------------------------------
7071
Bisecting: 337 revisions left to test after this
7172
------------------------------------------------
7273

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"
7576
or "git bisect bad" to ask for the next bisection.
7677

7778
Eventually there will be no more revisions left to bisect, and you
@@ -81,7 +82,7 @@ Bisect reset
8182
~~~~~~~~~~~~
8283

8384
To return to the original head after a bisect session, you issue the
84-
command:
85+
following command:
8586

8687
------------------------------------------------
8788
$ git bisect reset
@@ -94,14 +95,14 @@ the bisection state).
9495
Bisect visualize
9596
~~~~~~~~~~~~~~~~
9697

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:
98100

99101
------------
100102
$ git bisect visualize
101103
------------
102104

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`.
105106

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

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:
118120

119121
------------
120122
$ git bisect log
121123
------------
122124

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:
127129

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

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.
178180

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

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+
187191

188192
Cutting down bisection by giving more parameters to bisect start
189193
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
190194

191195
You can further cut down the number of trials, if you know what part of
192196
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:
194198

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

0 commit comments

Comments
 (0)