]> git.ipfire.org Git - thirdparty/git.git/commitdiff
Merge branch 'jc/bisect-doc' into maint-2.43
authorJunio C Hamano <gitster@pobox.com>
Tue, 13 Feb 2024 22:44:51 +0000 (14:44 -0800)
committerJunio C Hamano <gitster@pobox.com>
Tue, 13 Feb 2024 22:44:51 +0000 (14:44 -0800)
Doc update.

* jc/bisect-doc:
  bisect: document command line arguments for "bisect start"
  bisect: document "terms" subcommand more fully

1  2 
Documentation/git-bisect.txt

index aa02e462244ee0ad2836412cb2351fc43e9c43ad,73f889b97b8b6ccb601c5d21f2c6fe15ab871b7f..a0e75a62393d141b69c7dc2dbf2f417f795ed2fd
@@@ -16,17 -16,17 +16,17 @@@ DESCRIPTIO
  The command takes various subcommands, and different options depending
  on the subcommand:
  
-  git bisect start [--term-(new|bad)=<term-new> --term-(old|good)=<term-old>]
+  git bisect start [--term-(bad|new)=<term-new> --term-(good|old)=<term-old>]
                  [--no-checkout] [--first-parent] [<bad> [<good>...]] [--] [<paths>...]
   git bisect (bad|new|<term-new>) [<rev>]
   git bisect (good|old|<term-old>) [<rev>...]
-  git bisect terms [--term-good | --term-bad]
+  git bisect terms [--term-(good|old) | --term-(bad|new)]
   git bisect skip [(<rev>|<range>)...]
   git bisect reset [<commit>]
   git bisect (visualize|view)
   git bisect replay <logfile>
   git bisect log
 - git bisect run <cmd>...
 + git bisect run <cmd> [<arg>...]
   git bisect help
  
  This command uses a binary search algorithm to find which commit in
@@@ -165,8 -165,10 +165,10 @@@ To get a reminder of the currently use
  git bisect terms
  ------------------------------------------------
  
- You can get just the old (respectively new) term with `git bisect terms
- --term-old` or `git bisect terms --term-good`.
+ You can get just the old term with `git bisect terms --term-old`
+ or `git bisect terms --term-good`; `git bisect terms --term-new`
+ and `git bisect terms --term-bad` can be used to learn how to call
+ the commits more recent than the sought change.
  
  If you would like to use your own terms instead of "bad"/"good" or
  "new"/"old", you can choose any names you like (except existing bisect
@@@ -204,14 -206,9 +206,14 @@@ as an alternative to `visualize`)
  $ git bisect visualize
  ------------
  
 -If the `DISPLAY` environment variable is not set, 'git log' is used
 -instead.  You can also give command-line options such as `-p` and
 -`--stat`.
 +Git detects a graphical environment through various environment variables:
 +`DISPLAY`, which is set in X Window System environments on Unix systems.
 +`SESSIONNAME`, which is set under Cygwin in interactive desktop sessions.
 +`MSYSTEM`, which is set under Msys2 and Git for Windows.
 +`SECURITYSESSIONID`, which may be set on macOS in interactive desktop sessions.
 +
 +If none of these environment variables is set, 'git log' is used instead.
 +You can also give command-line options such as `-p` and `--stat`.
  
  ------------
  $ git bisect visualize --stat
@@@ -362,7 -359,7 +364,7 @@@ OPTION
  --no-checkout::
  +
  Do not checkout the new working tree at each iteration of the bisection
 -process. Instead just update a special reference named `BISECT_HEAD` to make
 +process. Instead just update the reference named `BISECT_HEAD` to make
  it point to the commit that should be tested.
  +
  This option may be useful when the test you would perform in each step