{"thread":{"id":"21733","subject":"[PATCH] Documentation: update descriptions of revision options related to '--bisect'","startedAt":"2009-11-24T06:54:44Z","lastAt":"2009-11-24T06:54:44Z","messageCount":1,"participants":["Christian Couder"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"128230","messageId":"20091124065445.4002.9082.chriscool@tuxfamily.org","threadId":"21733","inReplyTo":null,"subject":"[PATCH] Documentation: update descriptions of revision options related to '--bisect'","fromName":"Christian Couder","fromEmail":"chriscool@tuxfamily.org","sentAt":"2009-11-24T06:54:44Z","receivedAt":"2009-11-24T06:54:44Z","isPatch":true,"sender":{"key":"christian.couder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/208954?v=4"},"body":"In commit ad3f9a7 (Add '--bisect' revision machinery argument) the\n'--bisect' option was added to easily pass bisection refs to commands\nusing the revision machinery.\n\nThis patch updates the documentation of the related options to describe\nthe new behavior.\n\nSigned-off-by: Christian Couder <chriscool@tuxfamily.org>\n---\n Documentation/rev-list-options.txt |   39 ++++++++++++++++++++++++-----------\n 1 files changed, 27 insertions(+), 12 deletions(-)\n\ndiff --git a/Documentation/rev-list-options.txt b/Documentation/rev-list-options.txt\nindex b44fdd9..1f57aed 100644\n--- a/Documentation/rev-list-options.txt\n+++ b/Documentation/rev-list-options.txt\n@@ -243,6 +243,15 @@ endif::git-rev-list[]\n \tPretend as if all the refs in `$GIT_DIR/refs/remotes` are listed\n \ton the command line as '<commit>'.\n \n+ifndef::git-rev-list[]\n+--bisect::\n+\n+\tPretend as if the bad bisection ref `$GIT_DIR/refs/bisect/bad`\n+\twas listed and as if it was followed by `--not` and the good\n+\tbisection refs `$GIT_DIR/refs/bisect/good-*` on the command\n+\tline.\n+endif::git-rev-list[]\n+\n --stdin::\n \n \tIn addition to the '<commit>' listed on the command\n@@ -538,7 +547,11 @@ Bisection Helpers\n --bisect::\n \n Limit output to the one commit object which is roughly halfway between\n-the included and excluded commits. Thus, if\n+included and excluded commits. Note that the bad bisection ref\n+`$GIT_DIR/refs/bisect/bad` is added to the included commits (if it\n+exists) and the good bisection refs `$GIT_DIR/refs/bisect/good-*` are\n+added to the excluded commits (if they exist). Thus, supposing there\n+are no refs in `$GIT_DIR/refs/bisect/`, if\n \n -----------------------------------------------------------------------\n \t$ git rev-list --bisect foo ^bar ^baz\n@@ -558,22 +571,24 @@ one.\n \n --bisect-vars::\n \n-This calculates the same as `--bisect`, but outputs text ready\n-to be eval'ed by the shell. These lines will assign the name of\n-the midpoint revision to the variable `bisect_rev`, and the\n-expected number of commits to be tested after `bisect_rev` is\n-tested to `bisect_nr`, the expected number of commits to be\n-tested if `bisect_rev` turns out to be good to `bisect_good`,\n-the expected number of commits to be tested if `bisect_rev`\n-turns out to be bad to `bisect_bad`, and the number of commits\n-we are bisecting right now to `bisect_all`.\n+This calculates the same as `--bisect`, except that refs in\n+`$GIT_DIR/refs/bisect/` are not used, and except that this outputs\n+text ready to be eval'ed by the shell. These lines will assign the\n+name of the midpoint revision to the variable `bisect_rev`, and the\n+expected number of commits to be tested after `bisect_rev` is tested\n+to `bisect_nr`, the expected number of commits to be tested if\n+`bisect_rev` turns out to be good to `bisect_good`, the expected\n+number of commits to be tested if `bisect_rev` turns out to be bad to\n+`bisect_bad`, and the number of commits we are bisecting right now to\n+`bisect_all`.\n \n --bisect-all::\n \n This outputs all the commit objects between the included and excluded\n commits, ordered by their distance to the included and excluded\n-commits. The farthest from them is displayed first. (This is the only\n-one displayed by `--bisect`.)\n+commits. Refs in `$GIT_DIR/refs/bisect/` are not used. The farthest\n+from them is displayed first. (This is the only one displayed by\n+`--bisect`.)\n +\n This is useful because it makes it easy to choose a good commit to\n test when you want to avoid to test some of them for some reason (they\n-- \n1.6.5.1.gaf97d\n"}]}