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 <chriscool@tuxfamily.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Christian Couder committed
Nov 24, 2009 at 07:54 UTC
af06e93a3e822681ed2527388a9ded07d23428c5
1 file changed
+27
-12
Documentation/rev-list-options.txt
+27
-12
@@ -243,6 +243,15 @@ endif::git-rev-list[]
243
Pretend as if all the refs in `$GIT_DIR/refs/remotes` are listed
244
on the command line as '<commit>'.
245
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
+
255
--stdin::
256
257
In addition to the '<commit>' listed on the command
@@ -538,7 +547,11 @@ Bisection Helpers
547
--bisect::
548
549
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
555
556
-----------------------------------------------------------------------
557
$ git rev-list --bisect foo ^bar ^baz
@@ -558,22 +571,24 @@ one.
571
572
--bisect-vars::
573
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`.
584
585
--bisect-all::
586
587
This outputs all the commit objects between the included and excluded
588
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`.)
592
+
593
This is useful because it makes it easy to choose a good commit to
594
test when you want to avoid to test some of them for some reason (they