Skip to content

Commit af06e93

Browse files
chriscoolgitster
authored andcommitted
Documentation: update descriptions of revision options related to '--bisect'
In commit ad3f9a7 (Add '--bisect' revision machinery argument) the '--bisect' option was added to easily pass bisection refs to commands using the revision machinery. This patch updates the documentation of the related options to describe the new behavior. Signed-off-by: Christian Couder <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent fe3b2b7 commit af06e93

File tree

1 file changed

+27
-12
lines changed

1 file changed

+27
-12
lines changed

Documentation/rev-list-options.txt

Lines changed: 27 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -243,6 +243,15 @@ endif::git-rev-list[]
243243
Pretend as if all the refs in `$GIT_DIR/refs/remotes` are listed
244244
on the command line as '<commit>'.
245245

246+
ifndef::git-rev-list[]
247+
--bisect::
248+
249+
Pretend as if the bad bisection ref `$GIT_DIR/refs/bisect/bad`
250+
was listed and as if it was followed by `--not` and the good
251+
bisection refs `$GIT_DIR/refs/bisect/good-*` on the command
252+
line.
253+
endif::git-rev-list[]
254+
246255
--stdin::
247256

248257
In addition to the '<commit>' listed on the command
@@ -538,7 +547,11 @@ Bisection Helpers
538547
--bisect::
539548

540549
Limit output to the one commit object which is roughly halfway between
541-
the included and excluded commits. Thus, if
550+
included and excluded commits. Note that the bad bisection ref
551+
`$GIT_DIR/refs/bisect/bad` is added to the included commits (if it
552+
exists) and the good bisection refs `$GIT_DIR/refs/bisect/good-*` are
553+
added to the excluded commits (if they exist). Thus, supposing there
554+
are no refs in `$GIT_DIR/refs/bisect/`, if
542555

543556
-----------------------------------------------------------------------
544557
$ git rev-list --bisect foo ^bar ^baz
@@ -558,22 +571,24 @@ one.
558571

559572
--bisect-vars::
560573

561-
This calculates the same as `--bisect`, but outputs text ready
562-
to be eval'ed by the shell. These lines will assign the name of
563-
the midpoint revision to the variable `bisect_rev`, and the
564-
expected number of commits to be tested after `bisect_rev` is
565-
tested to `bisect_nr`, the expected number of commits to be
566-
tested if `bisect_rev` turns out to be good to `bisect_good`,
567-
the expected number of commits to be tested if `bisect_rev`
568-
turns out to be bad to `bisect_bad`, and the number of commits
569-
we are bisecting right now to `bisect_all`.
574+
This calculates the same as `--bisect`, except that refs in
575+
`$GIT_DIR/refs/bisect/` are not used, and except that this outputs
576+
text ready to be eval'ed by the shell. These lines will assign the
577+
name of the midpoint revision to the variable `bisect_rev`, and the
578+
expected number of commits to be tested after `bisect_rev` is tested
579+
to `bisect_nr`, the expected number of commits to be tested if
580+
`bisect_rev` turns out to be good to `bisect_good`, the expected
581+
number of commits to be tested if `bisect_rev` turns out to be bad to
582+
`bisect_bad`, and the number of commits we are bisecting right now to
583+
`bisect_all`.
570584

571585
--bisect-all::
572586

573587
This outputs all the commit objects between the included and excluded
574588
commits, ordered by their distance to the included and excluded
575-
commits. The farthest from them is displayed first. (This is the only
576-
one displayed by `--bisect`.)
589+
commits. Refs in `$GIT_DIR/refs/bisect/` are not used. The farthest
590+
from them is displayed first. (This is the only one displayed by
591+
`--bisect`.)
577592
+
578593
This is useful because it makes it easy to choose a good commit to
579594
test when you want to avoid to test some of them for some reason (they

0 commit comments

Comments
 (0)